ExAequoBase.Io (ExAequoBase v0.1.6)

View Source

Transform input from files, stdin, or binaries

Summary

Functions

From an enumerable of lines, create a list of tuples containing lines and line_numbers

Same as numbered_lines but just returning a stream

Types

atoms()

@type atoms() :: [atom()]

binaries()

@type binaries() :: [binary()]

either(lt, rt)

@type either(lt, rt) :: ok_t(lt) | error_t(rt)

error_t()

@type error_t() :: {:error, binary()}

error_t(t)

@type error_t(t) :: {:error, t}

input_source_t()

@type input_source_t() :: Enumerable.t() | binary() | binaries()

maybe(t)

@type maybe(t) :: nil | t

natural()

@type natural() :: non_neg_integer()

numbered(t)

@type numbered(t) :: {t, number()}

numbered_line_t()

@type numbered_line_t() :: numbered(binary())

numbered_lines_t()

@type numbered_lines_t() :: [numbered_line_t()]

ok_t()

@type ok_t() :: {:ok, any()}

ok_t(t)

@type ok_t(t) :: {:ok, t}

pair_t()

@type pair_t() :: {any(), any()}

pair_t(t)

@type pair_t(t) :: {t, t}

pair_t(lt, rt)

@type pair_t(lt, rt) :: {lt, rt}

pairs_t()

@type pairs_t() :: [pair_t()]

pairs_t(t)

@type pairs_t(t) :: [pair_t(t)]

pairs_t(lt, rt)

@type pairs_t(lt, rt) :: [pair_t(lt, rt)]

parser_fn()

@type parser_fn() :: (binary() -> any())

reducer_result_t()

@type reducer_result_t() :: {:halt, error_t()} | {:cont, ok_t()}

result_fun_t()

@type result_fun_t() :: (any() -> result_t())

result_fun_t(t)

@type result_fun_t(t) :: (any() -> result_t(t))

result_t()

@type result_t() :: either(any(), binary())

result_t(t)

@type result_t(t) :: either(t, binary())

rgx_pair()

@type rgx_pair() :: {Regex.t(), ExAequoFn.NamedFn.t()}

rgx_pairs()

@type rgx_pairs() :: [rgx_pair()]

stream_t()

@type stream_t() ::
  %IO.Stream{device: term(), line_or_bytes: term(), raw: term()}
  | %File.Stream{
      line_or_bytes: term(),
      modes: term(),
      node: term(),
      path: term(),
      raw: term()
    }

zero_fn_t()

@type zero_fn_t() :: (-> any())

zero_fn_t(t)

@type zero_fn_t(t) :: (-> t)

Functions

numbered_lines(input, initial_lnb \\ 1)

@spec numbered_lines(input_source_t(), number()) :: numbered_lines_t()

From an enumerable of lines, create a list of tuples containing lines and line_numbers

iex(1)> numbered_lines(~W[a b c])
[{"a", 1}, {"b", 2}, {"c", 3}]  

You can start with any number you want

iex(2)> numbered_lines(~W[a b c], -1.5)
[{"a", -1.5}, {"b", -0.5}, {"c", 0.5}]  

Why is this in a module called Io?

iex(3)> numbered_lines(fixture_stream!("three_lines"), 2)
[{"alpha", 2}, {"beta", 3}, {"gamma", 4}]  

numbered_lines_stream(input_source, initial_lnb \\ 1)

@spec numbered_lines_stream(input_source_t(), number()) :: Enumerable.t()

Same as numbered_lines but just returning a stream

iex(4)> s = numbered_lines_stream(~W[x y])
...(4)> assert is_function(s)
...(4)> s |> Enum.into([])
[{"x", 1}, {"y", 2}]