View Source argo_array_value (argo v1.1.0)

Summary

Types

-type index() :: non_neg_integer().
-type item() :: argo_value:t().
-opaque iterator()
-type iterator_order() :: ordered | reversed | key_func() | order_func().
-type key_func() :: fun((Index :: index(), Item :: item()) -> Key :: dynamic()).
-type order_func() ::
    fun((AIndex :: index(), AItem :: item(), BIndex :: index(), BItem :: item()) -> boolean()).
-type t() :: #argo_array_value{wire_type :: argo_array_wire_type:t(), items :: [argo_value:t()]}.

Functions

-spec iterator(ArrayValue) -> Iterator when ArrayValue :: t(), Iterator :: iterator().
Link to this function

iterator(ArrayValue, Order)

View Source
-spec iterator(ArrayValue, Order) -> Iterator
            when ArrayValue :: t(), Order :: iterator_order(), Iterator :: iterator().
Link to this function

new(ArrayWireType, Items)

View Source
-spec new(ArrayWireType, Items) -> ArrayValue
       when
           ArrayWireType :: argo_array_wire_type:t(), Items :: [argo_value:t()], ArrayValue :: t().
-spec next(Iterator) -> none | {Index, Item, NextIterator}
        when Index :: index(), Item :: item(), Iterator :: iterator(), NextIterator :: iterator().
-spec size(ArrayWireType) -> Size when ArrayWireType :: t(), Size :: non_neg_integer().
Link to this function

to_array_wire_type(ArrayValue)

View Source
-spec to_array_wire_type(ArrayValue) -> ArrayWireType
                      when ArrayValue :: t(), ArrayWireType :: argo_array_wire_type:t().