bibtex_parser v0.1.2 BibTex.Parser

Link to this section Summary

Functions

Parses the given binary as label

Parses the given binary as quoted

Parses the given binary as tag

Parses the given binary as tag_content

Parses the given binary as type

Parses the given binary as typelabel

Link to this section Functions

Link to this function label(binary, opts \\ [])
label(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 label.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map
Link to this function parse_entry(input)
Link to this function parse_label(input)
Link to this function parse_tag(input)
Link to this function parse_tag_content(input)
Link to this function parse_tag_name(input)
Link to this function parse_tags(input)
Link to this function quoted(binary, opts \\ [])
quoted(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 quoted.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map
Link to this function tag(binary, opts \\ [])
tag(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 tag.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map
Link to this function tag_content(binary, opts \\ [])
tag_content(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 tag_content.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map
Link to this function type(binary, opts \\ [])
type(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 type.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map
Link to this function typelabel(binary, opts \\ [])
typelabel(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 typelabel.

Returns {:ok, [token], rest, context, line, byte_offset} or {:error, reason, rest, context, line, byte_offset}.

Options

  • :line - the initial line, defaults to 1
  • :byte_offset - the initial byte offset, defaults to 0
  • :context - the initial context value. It will be converted to a map