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

# `line_action`

```elixir
@type line_action() :: :next | :continue
```

# `record_action`

```elixir
@type record_action() :: :no_record | :record | :clear | :clear_all
```

# `t`

```elixir
@type t() :: %TextFSM.Template.State.Rule.Action{
  line_action: line_action(),
  next_state: String.t(),
  record_action: record_action()
}
```

# `rule_action`

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

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

# `rule_action__1`

# `rule_action__2`

# `rule_action__3`

# `rule_action__4`

# `rule_action__5`

# `rule_action__6`

# `rule_action__7`

# `rule_action__8`

# `rule_action__9`

# `rule_action__10`

# `rule_action__11`

# `rule_action__12`

# `rule_action__13`

# `rule_action__14`

# `rule_action__15`

# `rule_action__16`

# `rule_action__17`

---

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