Struct diem_jellyfish_merkle::node_type::NodeKey

pub struct NodeKey { /* private fields */ }

The unique key of each node.

Implementations

impl NodeKey

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.

pub fn set_version(&mut self, version: Version)

Sets the version to the given version.

pub fn encode(&self) -> Result<Vec<u8>>

Serializes to bytes for physical storage enforcing the same order as that in memory.

pub fn decode(val: &[u8]) -> Result<NodeKey>

Recovers from serialized bytes in physical storage.

Trait Implementations

impl Arbitrary for NodeKey

type Parameters = (<u64 as Arbitrary>::Parameters, <NibblePath as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<(<u64 as Arbitrary>::Strategy, <NibblePath as Arbitrary>::Strategy), fn(_: (u64, NibblePath)) -> NodeKey>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for NodeKey

fn clone(&self) -> NodeKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeKey

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

Formats the value using the given formatter.

impl Hash for NodeKey

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 NodeKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NodeKey> for NodeKey

fn eq(&self, other: &NodeKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<NodeKey> for NodeKey

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for NodeKey

impl StructuralEq for NodeKey

impl StructuralPartialEq for NodeKey