Meeseeks

v0.11.0

Meeseeks v0.11.0 Meeseeks.Context View Source

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.

Link to this section Summary

Types

t()

Functions

accumulator_key()

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

add_accumulator(context, acc)

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)

Clears the context's matches map

ensure_accumulator!(context)

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

matches_key()

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

nodes_key()

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

prepare_for_selection(context)

Adds keys required by selection process to the context

return_accumulator(map)

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

return_key()

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

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

accumulator_key() View Source 
accumulator_key() :: atom()

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

Link to this function

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

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

Link to this function

add_to_accumulator(context, document, id) View Source 
add_to_accumulator(t(), Meeseeks.Document.t(), Meeseeks.Document.node_id()) ::
  t()

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.

Link to this function

add_to_matches(context, selector, node) View Source 
add_to_matches(t(), Meeseeks.Selector.t(), Meeseeks.Document.node_t()) ::
  t()

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

Link to this function

clear_matches(context) View Source 
clear_matches(t()) :: t()

Clears the context's matches map.

Link to this function

ensure_accumulator!(context) View Source 
ensure_accumulator!(t()) :: t()

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

Link to this function

matches_key() View Source 
matches_key() :: atom()

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

Link to this function

nodes_key() View Source 
nodes_key() :: atom()

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

Link to this function

prepare_for_selection(context) View Source 
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.

Link to this function

return_accumulator(map) View Source 
return_accumulator(t()) :: any()

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

Link to this function

return_key() View Source 
return_key() :: atom()

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