ExAequoBase.Text (ExAequoBase v0.1.6)

View Source

Text based tools

Summary

Functions

Removes a prefix (only if matching), or a given count of graphemes from the front of a string

Parses an input string up to a given string, returnig prefix and suffix

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

behead(string, by_string_or_length)

@spec behead(binary(), binary() | natural()) :: binary()

Removes a prefix (only if matching), or a given count of graphemes from the front of a string

iex(1)> behead("abc", "a")
"bc"


iex(2)> behead("abc", 2)
"c"

iex(3)> behead("abc", 0)
"abc"

But

iex(4)> assert_raise(
...(4)>   ExAequoBase.Text.Error,
...(4)>   fn -> behead("abc", "b")
...(4)> end)


iex(5)> assert_raise(
...(5)>   FunctionClauseError,
...(5)>   fn -> behead("abc", -1)
...(5)> end)

parse_up_to(input, delim, option \\ nil)

@spec parse_up_to(binary(), binary() | Regex.t(), atom()) ::
  maybe({binary(), binary()})

Parses an input string up to a given string, returnig prefix and suffix

iex(6)> parse_up_to("hello world", " ")
{"hello", "world"}

We can also use regular expressions

iex(7)> parse_up_to("hello  world", ~r/\s+/)
{"hello", "world"}

We can decide to keep the string we parse up to

iex(8)> parse_up_to("hello  world", ~r/\s+/, :keep)
{"hello", "  world"}

Or to include it into the macth

iex(9)> parse_up_to("hello  world", ~r/\s+/, :include)
{"hello  ", "world"}

If no match nil is returned

iex(10)> parse_up_to("hi there", ~r/\d+/)
nil