pelecanus v0.1.0 Pelecanus

Using

Pelecanus provide macro __using__/1. Using Pelecanus, basical submodules such as Pelecanus.TerminalSymbol or Pelecanus.Operator are imported.

You can pass option sigil_p: true. When this flag is set, it also import Pelecanus.Sigil which provide sigil ~p. ~p/foo/bar is shortened form of Pelecanus.TerminalSymbol.term(~r/foo/bar).

Example

iex> use Pelecanus, sigilp: true iex> parser = sequence [~p/hello/, ~p/, /, ~p/.+/] iex> {:ok, , result} = Pelecanus.parse “hello, world”, parser iex> result [“hello”, “, “, “world”]

Link to this section Summary

Functions

The action of this function has not been decided yet. Call this only in iex

Link to this section Types

Link to this type parser()
parser() :: (Pelecanus.State.t() -> result())
Link to this type reason()
reason() :: term()
Link to this type result()
result() ::
  {:ok, Pelecanus.State.t()}
  | {:ok, Pelecanus.State.t(), value()}
  | {:error, reason()}
Link to this type value()
value() :: term()

Link to this section Functions

Link to this function parse(string, e)

The action of this function has not been decided yet. Call this only in iex.