@spec parse(String.t(), []) ::
  Tablex.Table.t() | {:error, {:invalid, String.t(), String.t()}}

@spec parse(String.t(), []) :: Tablex.Table.t()

Parse a string into a table struct.

returns

Returns

%Tablex.Table{...} if succeeds, other wise {:error, {:invalid, reason, rest}}

Raising version of parse/2.

@spec table(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 table.

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

To column where the error occurred can be inferred from byte_offset - offset_to_start_of_line.

options

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