YuriTemplate.RFC6570 (yuri_template v1.0.0) View Source

This module contains RFC6570-specific functions.

Link to this section Summary

Types

t()

Internal template representation. Subject to change at any time without prior notice.

Functions

Expands the template using given substitutes into an iodata/0.

Parses the given string to the t/0.

Parses the given binary as parse1.

Link to this section Types

Specs

t()

Internal template representation. Subject to change at any time without prior notice.

Link to this section Functions

Link to this function

expand(template, substitutes)

View Source

Specs

expand(t(), Access.t()) :: iodata()

Expands the template using given substitutes into an iodata/0.

Specs

parse(String.t()) :: {:ok, t()} | {:error, term()}

Parses the given string to the t/0.

Link to this function

parse1(binary, opts \\ [])

View Source

Specs

parse1(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 parse1.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the parse1 (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