Matcha
Matcha v0.1.10

View Source Matcha.Source (Matcha v0.1.10)

Functions that work with the raw Erlang terms representing a match spec.

The "source" of a match specification is what Matcha calls data that fits the Erlang match specification grammar.

Matcha compiles Elixir code into such data, and wraps that data in structs. This module is the bridge between those structs and the Erlang functions that know how to operate on them.

Link to this section Summary

Types

all_matches()
body()
clause()
compiled()
condition()
conditions()
expression()
match_all()
match_result()
match_target()
pattern()
spec()
table_match_result()
trace_flags()
trace_match_result()
trace_message()
type()
uncompiled()

Functions

compile(source)

Compiles match spec source into an opaque, more efficient internal representation.

compiled?(value)

Checks if provided value is a compiled match spec source.

ensure_compiled(source)

Ensures provided match spec source is compiled.

run(source, list)

Runs a match spec source against a list of values.

test(source, type, match_target)

Validates match spec source of variant type and tries to match it against match_target.

Link to this section Types

Link to this type

all_matches()

View Source 
@type all_matches() :: :"$$"
Link to this type

body()

View Source 
@type body() :: [expression()]
Link to this type

clause()

View Source 
@type clause() :: {pattern(), conditions(), body()}
Link to this type

compiled()

View Source 
@type compiled() :: :ets.comp_match_spec()
Link to this type

condition()

View Source 
@type condition() :: tuple()
Link to this type

conditions()

View Source 
@type conditions() :: [condition()]
Link to this type

expression()

View Source 
@type expression() :: atom() | match_all() | all_matches() | tuple() | term()
Link to this type

match_all()

View Source 
@type match_all() :: :"$_"
Link to this type

match_result()

View Source 
@type match_result() ::
  {:ok, any(), trace_flags(), [{:error | :warning, charlist()}]}
  | {:error, [{:error | :warning, charlist()}]}
Link to this type

match_target()

View Source 
@type match_target() :: tuple() | [tuple()] | term()
Link to this type

pattern()

View Source 
@type pattern() :: tuple() | atom()
Link to this type

spec()

View Source 
@type spec() :: [clause()]
Link to this type

table_match_result()

View Source 
@type table_match_result() ::
  {:ok, any(), [], [{:error | :warning, charlist()}]}
  | {:error, [{:error | :warning, charlist()}]}
Link to this type

trace_flags()

View Source 
@type trace_flags() :: list()
Link to this type

trace_match_result()

View Source 
@type trace_match_result() ::
  {:ok, boolean() | trace_message(), trace_flags(),
   [{:error | :warning, charlist()}]}
  | {:error, [{:error | :warning, charlist()}]}
Link to this type

trace_message()

View Source 
@type trace_message() :: charlist()
Link to this type

type()

View Source 
@type type() :: :table | :trace
Link to this type

uncompiled()

View Source 
@type uncompiled() :: spec()

Link to this section Functions

Link to this function

compile(source)

View Source 
@spec compile(source :: uncompiled()) :: compiled()

Compiles match spec source into an opaque, more efficient internal representation.

Link to this function

compiled?(value)

View Source 
@spec compiled?(any()) :: boolean()

Checks if provided value is a compiled match spec source.

Link to this function

ensure_compiled(source)

View Source 
@spec ensure_compiled(source :: uncompiled() | compiled()) :: compiled()

Ensures provided match spec source is compiled.

Link to this function

run(source, list)

View Source 
@spec run(source :: uncompiled() | compiled(), list()) :: list()

Runs a match spec source against a list of values.

Link to this function

test(source, type, match_target)

View Source 
@spec test(source :: uncompiled(), type(), match_target()) :: match_result()

Validates match spec source of variant type and tries to match it against match_target.