Zippex v1.0.0 Zippex.Meta View Source

The metadata of a Zippex zipper. The Meta struct contains the following fields:

is_branch - A function that receives a node and returns true if the node is a branch
children - A function that receives a node and returns it's children
make_node - A function that receives a node and a list of children and returns a new node

Link to this section Summary

t()

Applies the children function on a node

Applies the is_branch function on a node

Applies the make_node function on a node and list of children

Returns a new Meta struct

children_fun() :: (element() -> [element()])

element() :: Zippex.element()

is_branch_fun() :: (element() -> boolean())

make_node_fun() :: (element(), [element()] -> element())

t() :: %Zippex.Meta{
  children: children_fun(),
  is_branch: is_branch_fun(),
  make_node: make_node_fun()
}

children(t(), element()) :: [element()]

Applies the children function on a node

is_branch(t(), element()) :: boolean()

Applies the is_branch function on a node

make_node(t(), element(), [element()]) :: element()

Applies the make_node function on a node and list of children

new(is_branch_fun(), children_fun(), make_node_fun()) :: t()

Returns a new Meta struct