Posexional.Field.Value (posexional v1.2.0)

View Source

this module represent a single field in a row of a positional file

Summary

Types

t()

@type t() :: %Posexional.Field.Value{
  alignment: term(),
  default: term(),
  filler: term(),
  name: term(),
  size: term()
}

Functions

new(name, size, opts \\ [])

@spec new(atom(), integer(), Keyword.t()) :: t()

write(field, value)

@spec write(t(), binary()) :: binary()

outputs a field

Examples

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 5), "test")
"test "

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 5), "too long")
** (RuntimeError) The value too long is too long for the test field. The maximum size is 5 while the value is 8

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 10), "test")
"test      "

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 10), "test")
"test      "

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 10, filler: ?0), "test")
"test000000"

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 10, filler: ?0, alignment: :right), "test")
"000000test"

iex> Posexional.Field.Value.write(Posexional.Field.Value.new(:test, 10), 50)
** (RuntimeError) The value provided for the test field doesn't seem to be a string