# `TextFSM.Template.State.Rule`
[🔗](https://github.com/amitbashan/textfsm/blob/main/lib/textfsm/template/state/rule.ex#L1)

# `regex_token`

```elixir
@type regex_token() :: char() | value_descriptor()
```

# `t`

```elixir
@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: []
}
```

# `value_descriptor`

```elixir
@type value_descriptor() :: {:value_descriptor, String.t()}
```

# `rule`

```elixir
@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

# `rule__0`

# `rule__1`

# `rule__2`

# `rule__3`

# `rule__4`

# `rule__5`

# `rule__6`

# `rule__7`

# `rule__8`

# `rule__9`

# `rule__10`

# `rule__11`

# `rule__12`

# `rule__13`

# `rule__14`

# `rule__15`

# `rule__16`

# `rule__17`

# `rule__18`

# `rule__19`

# `rule__20`

---

*Consult [api-reference.md](api-reference.md) for complete listing*