Summary
Functions
Parses the given binary as rule.
Types
@type regex_token() :: char() | value_descriptor()
@type t() :: %TextFSM.Template.State.Rule{ action: TextFSM.Template.State.Rule.Action.t() | TextFSM.Template.State.Rule.ErrorAction.t(), compiled_regex: Regex.t(), regex_tokens: [] }
@type value_descriptor() :: {:value_descriptor, String.t()}
Functions
@spec rule(binary(), keyword()) :: {:ok, [term()], rest, context, line, byte_offset} | {:error, reason, rest, context, line, byte_offset} when line: {pos_integer(), byte_offset}, byte_offset: non_neg_integer(), rest: binary(), reason: String.t(), context: map()
Parses the given binary as rule.
Returns {:ok, [token], rest, context, position, byte_offset} or
{:error, reason, rest, context, line, byte_offset} where position
describes the location of the rule (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
: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