TextFSM.Template.ValueDefinition (TextFSM v0.1.2)

Copy Markdown View Source

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.

Summary

Functions

Parses the given binary as value_definition.

Types

option()

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

t()

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

Functions

value_definition(binary, opts \\ [])

@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(rest, acc, stack, context, line, offset)

value_definition__1(rest, acc, stack, context, comb__line, comb__offset)

value_definition__2(rest, acc, stack, context, line, offset)

value_definition__3(rest, acc, stack, context, line, offset)

value_definition__4(rest, user_acc, list, context, line, offset)

value_definition__5(rest, acc, list, context, line, offset)

value_definition__6(_, _, stack, _, _, _)

value_definition__7(rest, acc, stack, context, line, offset)

value_definition__8(rest, acc, stack, context, line, offset)

value_definition__9(_, _, list, _, _, _)

value_definition__10(rest, acc, stack, context, comb__line, comb__offset)

value_definition__11(rest, acc, stack, context, line, offset)

value_definition__12(inner_rest, inner_acc, list, inner_context, inner_line, inner_offset)

value_definition__13(rest, acc, stack, context, line, offset)

value_definition__14(rest, acc, list, context, line, offset)

value_definition__15(rest, acc, stack, context, line, offset)

value_definition__16(rest, acc, stack, context, line, offset)

value_definition__17(rest, user_acc, list, context, line, offset)

value_definition__18(rest, acc, stack, context, line, offset)

value_definition__19(rest, acc, stack, context, line, offset)

value_definition__20(rest, acc, stack, context, comb__line, comb__offset)

value_definition__21(rest, acc, stack, context, line, offset)

value_definition__22(_, _, list, _, _, _)

value_definition__23(rest, acc, stack, context, line, offset)

value_definition__24(rest, acc, stack, context, comb__line, comb__offset)

value_definition__25(_, _, list, _, _, _)

value_definition__26(rest, acc, stack, context, line, offset)

value_definition__27(_, _, list, _, _, _)

value_definition__28(rest, acc, stack, context, line, offset)

value_definition__29(rest, acc, list, context, line, offset)

value_definition__30(_, _, stack, _, _, _)

value_definition__31(rest, acc, stack, context, comb__line, comb__offset)

value_definition__32(rest, acc, list, context, line, offset)

value_definition__33(rest, acc, stack, context, line, offset)

value_definition__34(inner_rest, inner_acc, list, inner_context, inner_line, inner_offset)

value_definition__35(rest, acc, stack, context, comb__line, comb__offset)

value_definition__36(rest, user_acc, list, context, line, offset)

value_definition__37(rest, user_acc, list, context, line, offset)

value_definition__38(rest, acc, stack, context, line, offset)