iteraptor v1.10.2 Iteraptable protocol 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

Functions

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

Link to this section Types

Link to this section Functions

Link to this function

name(term)

View Source
name(term :: any()) :: binary()

Returns a name of the term to be represented in flatmaps

Link to this function

to_collectable(term)

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

Converts a term to a collectable

Link to this function

to_enumerable(term)

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

Converts a term to an enumerable

Link to this function

type(term)

View Source
type(term :: any()) :: atom()

Returns a type understood by Iteraptable