Module gre

Accessor function for goldrush event terms.

Description

Accessor function for goldrush event terms.

Data Types

event()

event() = {list, [{atom(), term()}]}

Function Index

append/2
fetch/2Get the value of a field in an event.
find/2Find the value of a field in an event.
has/2Check if a field exists in an event.
keys/1Get the names of all fields in an event.
make/2Construct an event term.
merge/2
pairs/1Get the name and value of all fields in an event.

Function Details

append/2

append(KeyVal::term(), X2::event()) -> event()

fetch/2

fetch(Key::atom(), Event::event()) -> term()

Get the value of a field in an event. The field is expected to exist in the event.

find/2

find(Key::atom(), X2::event()) -> {true, term()} | false

Find the value of a field in an event. This is equivalent to testing if a field exists using has/2 before accessing the value of the field using fetch/2.

has/2

has(Key::atom(), X2::event()) -> boolean()

Check if a field exists in an event.

keys/1

keys(X1::event()) -> [atom()]

Get the names of all fields in an event.

make/2

make(Term::term(), X2::[list]) -> event()

Construct an event term.

merge/2

merge(X1::event(), X2::event()) -> event()

pairs/1

pairs(X1::event()) -> [{atom(), term()}]

Get the name and value of all fields in an event.


Generated by EDoc, May 28 2018, 15:25:56.