Struct Location 

pub struct Location<'t, T>
where
    T: CustomTraversal,
{
    pub start_offset: usize,
    pub end_offset: usize,
    pub ancestor_path: &'t [AncestorState<T>],
}

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.

Fields

start_offset: usize

An offset in the payload, where this Location starts. The meaning of this offset depends on the context of the event, eg:

• For ContainerStart, this is the start of the value
• For ContainerEnd, this is the start of the value
• For DecodeError, this is the location where the error occurred

end_offset: usize

An offset in the payload, where this Location ends (could be the same as start_offset). The meaning of this offset depends on the context of the event, eg:

• For ContainerStart, this is the end of the header
• For ContainerEnd, this is the end of the whole container value
• For DecodeError, this is the location where the error occurred

ancestor_path: &'t [AncestorState<T>]

The path of containers from the root to the current value. All containers in this list have current_child_index set. Note that for certain events:

• For ContainerStart/ContainerEnd, this does NOT include the newly started/ended container.
• For TerminalValue/TerminalValueBatch, this includes all ancestors of that value/value batch.
• For DecodeError, it only includes ancestors where we have started to read their children.
• For End, this is an empty slice

Implementations

impl<'t, T> Location<'t, T>

where T: CustomTraversal,

pub fn get_latest_ancestor(&self) -> Option<&AncestorState<T>>

pub fn get_start_offset_of_value_body(&self) -> usize

Gives the offset of the start of the value body (ignoring the value kind byte). The result is only valid if this location corresponds to a ContainerStart/TerminalValue/ContainerEnd event.

Trait Implementations

impl<'t, T> Clone for Location<'t, T>

where T: Clone + CustomTraversal,

fn clone(&self) -> Location<'t, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'t, T> Debug for Location<'t, T>

where T: Debug + CustomTraversal,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'t, T> PartialEq for Location<'t, T>

where T: PartialEq + CustomTraversal,

fn eq(&self, other: &Location<'t, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'t, T> Copy for Location<'t, T>

where T: Copy + CustomTraversal,

impl<'t, T> Eq for Location<'t, T>

where T: Eq + CustomTraversal,

impl<'t, T> StructuralPartialEq for Location<'t, T>

where T: CustomTraversal,