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

Represents a State in a TextFSM template.

A State is a named collection of Rules. The Engine starts in the 'Start' state.
Each line of input is matched against the rules in the current state.

# `t`

```elixir
@type t() :: %TextFSM.Template.State{
  name: String.t(),
  rules: [TextFSM.Template.State.Rule.t()]
}
```

# `state`

```elixir
@spec state(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 state.

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

# `state__0`

# `state__1`

# `state__2`

# `state__3`

# `state__4`

# `state__5`

# `state__6`

# `state__7`

# `state__8`

# `state__9`

# `state__10`

# `state__11`

# `state__12`

# `state__13`

# `state__14`

# `state__15`

# `state__16`

---

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