View Source argo_term (argo v1.1.0)
Summary
Types
-type array_value_hint() :: #{'of' := wire_type_hint(), size := argo_types:usize(), index := argo_types:index()}.
-type array_wire_type_hint() :: #{'of' := wire_type_hint()}.
-type block_wire_type_hint() :: #{'of' := scalar_wire_type_hint(), key := argo_types:name(), dedupe := boolean()}.
-type desc_value_container_hint() :: list | object.
-type desc_value_hint() :: desc_value_container_hint() | desc_value_scalar_hint().
-type desc_value_list_hint() :: #{'of' := desc_value_hint(), index := argo_types:index()}.
-type desc_value_object_hint() :: #{'of' := desc_value_hint(), index := argo_types:index(), key := argo_types:name()}.
-type desc_value_scalar_hint() :: null | boolean | string | bytes | int | float.
-type field_wire_type_hint() :: #{'of' := wire_type_hint(), name := argo_types:name(), omittable := boolean()}.
-type non_null_wire_type_hint() :: array | {block, block_wire_type_hint()} | desc | error | extensions | path | {record, record_wire_type_hint()} | {scalar, scalar_wire_type_hint()}.
-type nullable_wire_type_hint() :: #{'of' := non_null_wire_type_hint()}.
-type record_wire_type_hint() :: #{fields := [argo_types:name()]}.
-type scalar_wire_type_hint() :: boolean | bytes | desc | {fixed, argo_types:length()} | float64 | string | varint.
-type term_value() :: dynamic().
-type wire_type_hint() :: nullable | non_null_wire_type_hint().
Functions
-spec array_value_hint(ArrayValue, Index) -> ArrayValueHint when ArrayValue :: argo_array_value:t(), Index :: non_neg_integer(), ArrayValueHint :: array_value_hint().
-spec array_wire_type_hint(ArrayValue | ArrayWireType) -> ArrayWireTypeHint when ArrayValue :: argo_array_value:t(), ArrayWireType :: argo_array_wire_type:t(), ArrayWireTypeHint :: array_wire_type_hint().
-spec block_wire_type_hint(BlockValue | BlockWireType) -> BlockWireTypeHint when BlockValue :: argo_block_value:t(), BlockWireType :: argo_block_wire_type:t(), BlockWireTypeHint :: block_wire_type_hint().
-spec desc_value_hint(DescInner | DescValue) -> DescValueHint when DescInner :: argo_desc_value:inner(), DescValue :: argo_desc_value:t(), DescValueHint :: desc_value_hint().
-spec desc_value_list_hint(DescValue, Index) -> DescValueListHint when DescValue :: argo_desc_value:t(), Index :: argo_types:index(), DescValueListHint :: desc_value_list_hint().
-spec desc_value_object_hint(DescValue, Index, Key) -> DescValueObjectHint when DescValue :: argo_desc_value:t(), Index :: argo_types:index(), Key :: argo_types:name(), DescValueObjectHint :: desc_value_object_hint().
-spec field_wire_type_hint(FieldValue | FieldWireType) -> FieldWireTypeHint when FieldValue :: argo_field_value:t(), FieldWireType :: argo_field_wire_type:t(), FieldWireTypeHint :: field_wire_type_hint().
-spec nullable_wire_type_hint(NullableValue | NullableWireType) -> NullableWireTypeHint when NullableValue :: argo_nullable_value:t(), NullableWireType :: argo_nullable_wire_type:t(), NullableWireTypeHint :: nullable_wire_type_hint().
-spec record_wire_type_hint(RecordValue | RecordWireType) -> RecordWireTypeHint when RecordValue :: argo_record_value:t(), RecordWireType :: argo_record_wire_type:t(), RecordWireTypeHint :: record_wire_type_hint().
-spec scalar_wire_type_hint(ScalarValue | ScalarWireType) -> ScalarWireTypeHint when ScalarValue :: argo_scalar_value:t(), ScalarWireType :: argo_scalar_wire_type:t(), ScalarWireTypeHint :: scalar_wire_type_hint().
-spec wire_type_hint(Value | WireType) -> WireTypeHint when Value :: argo_value:t(), WireType :: argo_wire_type:t(), WireTypeHint :: wire_type_hint().