Meeseeks v0.7.3 Meeseeks.Context

Context is available to both Meeseek's selection process and each individual selector, and allows for selectors to build state (or receive state from the selection mechanism).

The selection process expects an accumulator, return? boolean, and matches map to exist in the context, and stores selected nodes in the accumulator, stores matching nodes than need to be filtered in the matches map, and halts selection if the return? boolean becomes true.

Summary

Functions

Returns the key under which the accumulator is stored in the context

Adds an accumulator to context, overriding any existing accumulator in context

Updates the context's accumulator with the result of calling Accumulator.add on the current accumulator with the provided document and id, and sets return? to the result of calling Accumulator.complete? on the updated accumulator if return? was not already true

Adds a node to a list in the context's matches map corresponding to the selector that the node matched

Clears the context's matches map

Ensures that context contains an accumulator, returning context if it does, or raising an error if it does not

Returns the key under which matching nodes that need to be filtered are stored in the context

Returns the key under which the nodes currently being walked are stored in the context

Adds keys required by selection process to the context

Returns the result of calling Accumulator.return on the context's accumulator

Returns the key under which return? is stored in the context

Types

t()
t() :: %{optional(any) => any}

Functions

accumulator_key()
accumulator_key() :: atom

Returns the key under which the accumulator is stored in the context.

add_accumulator(context, acc)
add_accumulator(t, Meeseeks.Accumulator.t) :: t

Adds an accumulator to context, overriding any existing accumulator in context.

add_to_accumulator(context, document, id)

Updates the context's accumulator with the result of calling Accumulator.add on the current accumulator with the provided document and id, and sets return? to the result of calling Accumulator.complete? on the updated accumulator if return? was not already true.

add_to_matches(context, selector, node)

Adds a node to a list in the context's matches map corresponding to the selector that the node matched.

clear_matches(context)
clear_matches(t) :: t

Clears the context's matches map.

ensure_accumulator!(context)
ensure_accumulator!(t) :: t

Ensures that context contains an accumulator, returning context if it does, or raising an error if it does not.

matches_key()
matches_key() :: atom

Returns the key under which matching nodes that need to be filtered are stored in the context.

nodes_key()
nodes_key() :: atom

Returns the key under which the nodes currently being walked are stored in the context.

prepare_for_selection(context)
prepare_for_selection(t) :: t

Adds keys required by selection process to the context.

Used internally by Meeseeks.Select- users should have no reason to call.

return_accumulator(map)
return_accumulator(t) :: any

Returns the result of calling Accumulator.return on the context's accumulator.

return_key()
return_key() :: atom

Returns the key under which return? is stored in the context.