hackney_bstr.md

Module hackney_bstr

• Data Types
• Function Index
• Function Details

Data Types

cp()

abstract datatype: cp()

part()

part() = {Start::non_neg_integer(), Length::integer()}

END: Remove when OTP 17 not officially supported

Function Index

alpha/2	Parse a list of case-insensitive alpha characters.
char_to_lower/1	Convert [A-Z] characters to lowercase.
char_to_upper/1	Convert [a-z] characters to uppercase.
digits/1	Parse a list of digits as a non negative integer.
digits/2
digits/3
join/2
list/2	Parse a list of the given type.
nonempty_list/2	Parse a non-empty list of the given type.
parameterized_tokens/1	Parse a non empty list of tokens followed with optional parameters.
params/2	Parse a list of parameters (a=b;c=d).
quoted_string/2
split/3
to_binary/1
to_hex/1
to_lower/1	Convert a binary string to lowercase.
to_upper/1
token/2	Parse a token.
token_ci/2	Parse a case-insensitive token.
trim/1
whitespace/2	Skip whitespace.
word/2	Parse either a token or a quoted string.

Function Details

alpha/2

alpha(Data::binary(), Fun::function()) -> any()

Parse a list of case-insensitive alpha characters.

Changes all characters to lowercase.

char_to_lower/1

char_to_lower(Ch::char()) -> char()

Convert [A-Z] characters to lowercase.

char_to_upper/1

char_to_upper(Ch::char()) -> char()

Convert [a-z] characters to uppercase.

digits/1

digits(Data::binary()) -> non_neg_integer() | {error, badarg}

Parse a list of digits as a non negative integer.

digits/2

digits(Data::binary(), Fun::function()) -> any()

digits/3

digits(Data::binary(), Fun::function(), Acc::non_neg_integer()) -> any()

join/2

join(L, Separator) -> any()

list/2

list(Data::binary(), Fun::function()) -> list() | {error, badarg}

Parse a list of the given type.

nonempty_list/2

nonempty_list(Data::binary(), Fun::function()) -> [any(), ...] | {error, badarg}

Parse a non-empty list of the given type.

parameterized_tokens/1

parameterized_tokens(Data::binary()) -> any()

Parse a non empty list of tokens followed with optional parameters.

params/2

params(Data::binary(), Fun::function()) -> any()

Parse a list of parameters (a=b;c=d).

quoted_string/2

quoted_string(X1::binary(), Fun::function()) -> any()

split/3

split(Subject, Pattern, Options) -> Parts

• Subject = binary()
• Pattern = binary() | [binary()] | cp()
• Options = [Option]
• Option = {scope, part()} | trim | global | trim_all
• Parts = [binary()]

to_binary/1

to_binary(V) -> any()

to_hex/1

to_hex(Bin) -> any()

to_lower/1

to_lower(L::binary() | atom() | list()) -> binary()

Convert a binary string to lowercase.

to_upper/1

to_upper(U::binary() | atom() | list()) -> binary()

token/2

token(Data::binary(), Fun::function()) -> any()

Parse a token.

token_ci/2

token_ci(Data::binary(), Fun::function()) -> any()

Parse a case-insensitive token.

Changes all characters to lowercase.

trim/1

trim(Data::binary()) -> binary()

whitespace/2

whitespace(Data::binary(), Fun::function()) -> any()

Skip whitespace.

word/2

word(Data::binary(), Fun::function()) -> any()

Parse either a token or a quoted string.