#[repr(transparent)]
pub struct Position(_);
Expand description

A type representing the position of a leaf in a Merkle tree.

Implementations§

source§

impl Position

source

pub fn is_right_child(&self) -> bool

Return whether the position refers to the right-hand child of a subtree with its root at level 1.

source

pub fn root_level(&self) -> Level

Returns the minimum possible level of the root of a binary tree containing at least self + 1 leaves.

source

pub fn past_ommer_count(&self) -> u8

Returns the number of cousins and/or ommers required to construct an authentication path to the root of a merkle tree that has self + 1 leaves.

source

pub fn is_complete_subtree(&self, root_level: Level) -> bool

Returns whether the binary tree having self as the position of the rightmost leaf contains a perfect balanced tree with a root at level root_level that contains the aforesaid leaf.

source

pub fn witness_addrs( &self, root_level: Level ) -> impl Iterator<Item = (Address, Source)>

Returns an iterator over the addresses of nodes required to create a witness for this position, beginning with the sibling of the leaf at this position and ending with the sibling of the ancestor of the leaf at this position that is required to compute a root at the specified level.

Trait Implementations§

source§

impl Add<u64> for Position

§

type Output = Position

The resulting type after applying the + operator.
source§

fn add(self, other: u64) -> Self

Performs the + operation. Read more
source§

impl AddAssign<u64> for Position

source§

fn add_assign(&mut self, other: u64)

Performs the += operation. Read more
source§

impl Clone for Position

source§

fn clone(&self) -> Position

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Position

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> From<&'a Position> for Address

source§

fn from(p: &'a Position) -> Self

Converts to this type from the input type.
source§

impl From<Position> for Address

source§

fn from(p: Position) -> Self

Converts to this type from the input type.
source§

impl From<Position> for u64

source§

fn from(p: Position) -> Self

Converts to this type from the input type.
source§

impl From<u64> for Position

source§

fn from(sz: u64) -> Self

Converts to this type from the input type.
source§

impl Hash for Position

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Position

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<Position> for Position

source§

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

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

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.
source§

impl PartialOrd<Position> for Position

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Sub<u64> for Position

§

type Output = Position

The resulting type after applying the - operator.
source§

fn sub(self, other: u64) -> Self

Performs the - operation. Read more
source§

impl TryFrom<Position> for usize

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

fn try_from(p: Position) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<usize> for Position

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

fn try_from(sz: usize) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for Position

source§

impl Eq for Position

source§

impl StructuralEq for Position

source§

impl StructuralPartialEq for Position

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V