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

Represents a Value definition in a TextFSM template.

A Value definition line looks like:
    Value [Option,Option...] Name (Regex)

It defines a column that will be in the resulting table.

# `option`

```elixir
@type option() :: :filldown | :key | :required | :list | :fillup
```

# `t`

```elixir
@type t() :: %TextFSM.Template.ValueDefinition{
  name: String.t(),
  options: [option()],
  regex: String.t()
}
```

# `value_definition`

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

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

# `value_definition__0`

# `value_definition__1`

# `value_definition__2`

# `value_definition__3`

# `value_definition__4`

# `value_definition__5`

# `value_definition__6`

# `value_definition__7`

# `value_definition__8`

# `value_definition__9`

# `value_definition__10`

# `value_definition__11`

# `value_definition__12`

# `value_definition__13`

# `value_definition__14`

# `value_definition__15`

# `value_definition__16`

# `value_definition__17`

# `value_definition__18`

# `value_definition__19`

# `value_definition__20`

# `value_definition__21`

# `value_definition__22`

# `value_definition__23`

# `value_definition__24`

# `value_definition__25`

# `value_definition__26`

# `value_definition__27`

# `value_definition__28`

# `value_definition__29`

# `value_definition__30`

# `value_definition__31`

# `value_definition__32`

# `value_definition__33`

# `value_definition__34`

# `value_definition__35`

# `value_definition__36`

# `value_definition__37`

# `value_definition__38`

---

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