Meeseeks.Accumulator behaviour (Meeseeks v0.17.0) View Source

Accumulator structs package some means of storing nodes selected during the selection process along with a method for checking if the selection should be terminated early and a method for returning the stored nodes.

Users will not typically need to define, or even know about, accumulators, but for users trying to do things like return selected nodes as Document nodes (or even tuple-tree nodes) instead of as Results, a custom accumulator will provide the solution.

Link to this section Summary

Types

t()

Functions

add(accumulator, document, id)

Provided a document and a node id, returns an updated accumulator.

complete?(accumulator)

Checks if an accumulator has reached an arbitrary state of completion and no longer wishes to be added to.

return(accumulator)

Returns the values accumulated by the accumulator.

Callbacks

add(accumulator, document, id)

Invoked to add a selected node to the accumulator.

complete?(accumulator)

Invoked to determine if the accumulator is satisfied.

return(accumulator)

Invoked to return the accumulation.

Link to this section Types

t()

Specs

t() :: struct()

Link to this section Functions

add(accumulator, document, id)

Specs

add(t(), Meeseeks.Document.t(), Meeseeks.Document.node_id()) :: t()

Provided a document and a node id, returns an updated accumulator.

complete?(accumulator)

Specs

complete?(t()) :: boolean()

Checks if an accumulator has reached an arbitrary state of completion and no longer wishes to be added to.

return(accumulator)

Specs

return(t()) :: any()

Returns the values accumulated by the accumulator.

Link to this section Callbacks

add(accumulator, document, id)

Specs

add(
  accumulator :: t(),
  document :: Meeseeks.Document.t(),
  id :: Meeseeks.Document.node_id()
) ::
  t()

Invoked to add a selected node to the accumulator.

complete?(accumulator)

Specs

complete?(accumulator :: t()) :: boolean()

Invoked to determine if the accumulator is satisfied.

return(accumulator)

Specs

return(accumulator :: t()) :: any()

Invoked to return the accumulation.