View Source argo_record_value (argo v1.1.0)

Summary

Types

index()
iterator()
iterator_order()
key()
key_func()
order_func()
t()
value()

Functions

find(RecordValue, Name)
find_index(RecordValue, Index)
find_index_of(RecordValue, Name)
insert(RecordValue, FieldValue)
iterator(RecordValue)
iterator(RecordValue, Order)
new()
next(Iterator)
present_fields_count(RecordValue)
to_record_wire_type(RecordValue)

Types

Link to this type

index()

View Source 
-type index() :: argo_index_map:index().
Link to this opaque

iterator()

View Source 
-opaque iterator()
Link to this type

iterator_order()

View Source 
-type iterator_order() :: ordered | reversed | key_func() | order_func().
Link to this type

key()

View Source 
-type key() :: argo_types:name().
Link to this type

key_func()

View Source 
-type key_func() :: fun((Index :: index(), Key :: key(), Value :: value()) -> Key :: dynamic()).
Link to this type

order_func()

View Source 
-type order_func() :: argo_index_map:iterator_order_func(key(), value()).
Link to this type

t()

View Source 
-type t() :: #argo_record_value{fields :: argo_index_map:t(argo_types:name(), argo_field_value:t())}.
Link to this type

value()

View Source 
-type value() :: argo_field_value:t().

Functions

Link to this function

find(RecordValue, Name)

View Source 
-spec find(RecordValue, Name) -> {ok, FieldValue} | error
        when RecordValue :: t(), Name :: argo_types:name(), FieldValue :: argo_field_value:t().
Link to this function

find_index(RecordValue, Index)

View Source 
-spec find_index(RecordValue, Index) -> {ok, FieldValue} | error
              when
                  RecordValue :: t(),
                  Index :: argo_index_map:index(),
                  FieldValue :: argo_field_value:t().
Link to this function

find_index_of(RecordValue, Name)

View Source 
-spec find_index_of(RecordValue, Name) -> {ok, Index, FieldValue} | error
                 when
                     RecordValue :: t(),
                     Name :: argo_types:name(),
                     Index :: argo_index_map:index(),
                     FieldValue :: argo_field_value:t().
Link to this function

insert(RecordValue, FieldValue)

View Source 
-spec insert(RecordValue, FieldValue) -> RecordValue
          when RecordValue :: t(), FieldValue :: argo_field_value:t().
Link to this function

iterator(RecordValue)

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

iterator(RecordValue, Order)

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

new()

View Source 
-spec new() -> RecordValue when RecordValue :: t().
Link to this function

next(Iterator)

View Source 
-spec next(Iterator) -> none | {Index, Key, Value, NextIterator}
        when
            Index :: index(),
            Key :: key(),
            Value :: value(),
            Iterator :: iterator(),
            NextIterator :: iterator().
Link to this function

present_fields_count(RecordValue)

View Source 
-spec present_fields_count(RecordValue) -> non_neg_integer() when RecordValue :: t().
Link to this function

to_record_wire_type(RecordValue)

View Source 
-spec to_record_wire_type(RecordValue) -> RecordWireType
                       when RecordValue :: t(), RecordWireType :: argo_record_wire_type:t().