Specs

parse(binary(), Keyword.t()) ::
  {:ok, HttpStructuredField.item() | list()} | {:error, term()}

Parse Structured Field.

By default, assumes that input is a single Item or a List. For Dictionaries, set the type: :dict option.

Returns a tagged tuple with the result or an error if parsing failed. If the item has paramerters, then the tuple also contains a list of parameters. Parmeters and dictionary members are represented as lists of tuples where the name is the first tuple element.

Specs

parsec_parse_dict(binary(), keyword()) ::
  {:ok, [term()], rest, context, line, byte_offset}
  | {:error, reason, rest, context, line, byte_offset}
when line: {pos_integer(), byte_offset},
     byte_offset: pos_integer(),
     rest: binary(),
     reason: String.t(),
     context: map()

Parses the given binary as parsec_parse_dict.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the parsec_parse_dict (start position) as {line, column_on_line}.

Options

• :byte_offset - the byte offset for the whole binary, defaults to 0
• :line - the line and the byte offset into that line, defaults to {1, byte_offset}
• :context - the initial context value. It will be converted to a map

Specs

parsec_parse_list(binary(), keyword()) ::
  {:ok, [term()], rest, context, line, byte_offset}
  | {:error, reason, rest, context, line, byte_offset}
when line: {pos_integer(), byte_offset},
     byte_offset: pos_integer(),
     rest: binary(),
     reason: String.t(),
     context: map()

Parses the given binary as parsec_parse_list.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the parsec_parse_list (start position) as {line, column_on_line}.

Options

• :byte_offset - the byte offset for the whole binary, defaults to 0
• :line - the line and the byte offset into that line, defaults to {1, byte_offset}
• :context - the initial context value. It will be converted to a map