Struct LeafIndex 

pub struct LeafIndex<const DEPTH: u8> { /* private fields */ }

The index of a leaf, at a depth known at compile-time.

Implementations

impl<const DEPTH: u8> LeafIndex<DEPTH>

pub fn new(value: u64) -> Result<LeafIndex<DEPTH>, MerkleError>

Creates a new LeafIndex with the specified value.

Errors

Returns an error if the provided depth is less than the minimum supported depth.

pub fn position(&self) -> u64

Returns the position of this leaf index within its depth layer.

impl LeafIndex<miden_crypto::::merkle::smt::{impl#2}::{constant#0}>

pub const fn new_max_depth( value: u64, ) -> LeafIndex<miden_crypto::::merkle::smt::{impl#2}::{constant#0}>

Creates a new LeafIndex at the maximum supported depth without validation.

Trait Implementations

impl<const DEPTH: u8> Clone for LeafIndex<DEPTH>

fn clone(&self) -> LeafIndex<DEPTH>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const DEPTH: u8> Debug for LeafIndex<DEPTH>

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

Formats the value using the given formatter.

impl<const DEPTH: u8> Default for LeafIndex<DEPTH>

fn default() -> LeafIndex<DEPTH>

Returns the “default value” for a type.

impl<const DEPTH: u8> Deserializable for LeafIndex<DEPTH>

fn read_from<R>( source: &mut R, ) -> Result<LeafIndex<DEPTH>, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de, const DEPTH: u8> Deserialize<'de> for LeafIndex<DEPTH>

fn deserialize<__D>( __deserializer: __D, ) -> Result<LeafIndex<DEPTH>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const DEPTH: u8> Display for LeafIndex<DEPTH>

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

Formats the value using the given formatter.

impl<const DEPTH: u8> From<LeafIndex<DEPTH>> for NodeIndex

fn from(value: LeafIndex<DEPTH>) -> NodeIndex

Converts to this type from the input type.

impl From<Word> for LeafIndex<miden_crypto::::merkle::smt::full::{impl#3}::{constant#0}>

fn from( value: Word, ) -> LeafIndex<miden_crypto::::merkle::smt::full::{impl#3}::{constant#0}>

Converts to this type from the input type.

impl<const DEPTH: u8> Hash for LeafIndex<DEPTH>

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

where __H: Hasher,

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<const DEPTH: u8> Ord for LeafIndex<DEPTH>

fn cmp(&self, other: &LeafIndex<DEPTH>) -> 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<const DEPTH: u8> PartialEq for LeafIndex<DEPTH>

fn eq(&self, other: &LeafIndex<DEPTH>) -> 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<const DEPTH: u8> PartialOrd for LeafIndex<DEPTH>

fn partial_cmp(&self, other: &LeafIndex<DEPTH>) -> 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<const DEPTH: u8> Serializable for LeafIndex<DEPTH>

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl<const DEPTH: u8> Serialize for LeafIndex<DEPTH>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const DEPTH: u8> TryFrom<NodeIndex> for LeafIndex<DEPTH>

type Error = MerkleError

The type returned in the event of a conversion error.

fn try_from( node_index: NodeIndex, ) -> Result<LeafIndex<DEPTH>, <LeafIndex<DEPTH> as TryFrom<NodeIndex>>::Error>

Performs the conversion.

impl<const DEPTH: u8> Copy for LeafIndex<DEPTH>

impl<const DEPTH: u8> Eq for LeafIndex<DEPTH>

impl<const DEPTH: u8> StructuralPartialEq for LeafIndex<DEPTH>