posexional v0.4.3 Posexional.File

a Posexional.File is the main struct to manage a positional file

Link to this section Summary

Link to this section Functions

Link to this function find_row(file, name)
find_row(%Posexional.File{rows: term, separator: term}, atom) :: %Posexional.Row{fields: term, name: term, row_guesser: term, separator: term}
Link to this function get_counters(file)
get_counters(%Posexional.File{rows: term, separator: term}) :: [{atom, pid}]
Link to this function manage_counters(file)
manage_counters(%Posexional.File{rows: term, separator: term}) :: %Posexional.File{rows: term, separator: term}

adds a generator for every progressive_number_field in the file.

The fields are grouped by name, so that you can specify many counters for every row

Link to this function new(rows, separator \\ nil)
Link to this function read(file, content)
read(%Posexional.File{rows: term, separator: term}, binary) :: Keyword.t
Link to this function write(file, values)
write(%Posexional.File{rows: term, separator: term}, Keyword.t) :: binary

creates a file from values

Examples

iex> Posexional.File.write(
...>   Posexional.File.new([ Posexional.Row.new(:row_test, [ Posexional.Field.Value.new(:test1, 5) ]) ]),
...>   [row_test: [test1: "test"], row_test: [test1: "t"]]
...> )
"test \nt    "

iex> Posexional.File.write(
...>   Posexional.File.new([ Posexional.Row.new(:row_test, [ Posexional.Field.Value.new(:test1, 5) ]) ]),
...>   [row_test: [test1: "test"], ne: [test1: "t"]]
...> )
** (RuntimeError) row ne not found
Link to this function write_path!(file, values, path)
write_path!(%Posexional.File{rows: term, separator: term}, Keyword.t, binary) :: binary