Iteraptable protocol (iteraptor v1.13.1) View Source

The protocol specifying how the respective struct might be used within Iteraptor.

Experimental. By implementing this protocol one might change the behaviour of nested objects regarding how they should be iterated through.

Link to this section Summary

t()

Returns a name of the term to be represented in flatmaps

Converts a term to a collectable

Converts a term to an enumerable

Returns a type understood by Iteraptable

t() :: term()

name(term :: any()) :: binary()

Returns a name of the term to be represented in flatmaps

to_collectable(term :: any()) :: Collectable.t()

Converts a term to a collectable

to_enumerable(term :: any()) :: Enumerable.t()

Converts a term to an enumerable

type(term :: any()) :: atom()

Returns a type understood by Iteraptable