Iteraptable protocol (iteraptor v1.15.0)

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.

Summary

t()

All the types that implement this protocol.

name(term)

Returns a name of the term to be represented in flatmaps

Converts a term to a collectable

Converts a term to an enumerable

type(term)

Returns a type understood by Iteraptable

@type t() :: term()

All the types that implement this protocol.

@spec name(term :: any()) :: binary()

Returns a name of the term to be represented in flatmaps

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

Converts a term to a collectable

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

Converts a term to an enumerable

@spec type(term :: any()) :: atom()

Returns a type understood by Iteraptable