Struct TreeNodeKey 

pub struct TreeNodeKey { /* private fields */ }

The unique key of each node.

Implementations

impl TreeNodeKey

pub fn new(version: Version, nibble_path: NibblePath) -> Self

Creates a new NodeKey.

pub fn new_empty_path(version: Version) -> Self

A shortcut to generate a node key consisting of a version and an empty nibble path.

pub fn version(&self) -> Version

Gets the version.

pub fn nibble_path(&self) -> &NibblePath

Gets the nibble path.

pub fn gen_child_node_key(&self, version: Version, n: Nibble) -> Self

Generates a child node key based on this node key.

pub fn gen_parent_node_key(&self) -> Self

Generates parent node key at the same version based on this node key.

Trait Implementations

impl<X: CustomValueKind> Categorize<X> for TreeNodeKey

fn value_kind() -> ValueKind<X>

impl Clone for TreeNodeKey

fn clone(&self) -> TreeNodeKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeNodeKey

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

Formats the value using the given formatter.

impl<D: Decoder<X>, X: CustomValueKind> Decode<X, D> for TreeNodeKey

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X>, ) -> Result<Self, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<C: CustomTypeKind<RustTypeId>> Describe<C> for TreeNodeKey

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl Display for TreeNodeKey

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

Formats the value using the given formatter.

impl<E: Encoder<X>, X: CustomValueKind> Encode<X, E> for TreeNodeKey

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl Eq for TreeNodeKey

impl From<TreeNodeKey> for (Version, NibblePath)

fn from(value: TreeNodeKey) -> Self

Converts to this type from the input type.

impl Hash for TreeNodeKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TreeNodeKey

fn cmp(&self, other: &TreeNodeKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TreeNodeKey

fn eq(&self, other: &TreeNodeKey) -> 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 PartialOrd for TreeNodeKey

fn partial_cmp(&self, other: &TreeNodeKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<X: CustomValueKind> SborTuple<X> for TreeNodeKey

fn get_length(&self) -> usize

impl StructuralPartialEq for TreeNodeKey