Module sbor::traversal

SBOR structured payload traversal.

Modules

• typed 🔒
• untyped 🔒

Macros

• look_up_type
• return_if_error
• return_type_mismatch_error
• terminal_value
• terminal_value_from_body

Structs

• ArrayHeader
• ContainerState
• CurrentValueInfo
• EnumVariantHeader
• FullLocation
• LocatedTraversalEvent
• Location
  The Location of the encoding - capturing both the byte offset in the payload, and also the container-path-based location in the SBOR value model.
• MapHeader
• TupleHeader
• TypedLocatedTraversalEvent
• TypedLocation
• TypedTraverser
  The TypedTraverser is for streamed decoding of a payload with type kinds.
• ValueTreeSummary
• VecTraverser
  The VecTraverser is for streamed decoding of a payload or single encoded value (tree). It turns payload decoding into a pull-based event stream.

Enums

• ContainerHeader
• ContainerType
• ExpectedStart
• NextEventOverride
• TerminalValueBatchRef
• TerminalValueRef
• TraversalEvent
• TypeMismatchError
• TypedTraversalError
• TypedTraversalEvent

Traits

• CustomTerminalValueRef
• CustomTraversal

Functions

• calculate_value_tree_body_byte_length
  Returns the length of the value at the start of the partial payload.
• traverse_partial_payload_with_types
• traverse_payload_with_types