Struct incrementalmerkletree::Position

pub struct Position(/* private fields */);

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

Implementations

impl Position

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.

pub fn root_level(&self) -> Level

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

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.

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.

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

impl Add<u64> for Position

type Output = Position

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u64> for Position

fn add_assign(&mut self, other: u64)

Performs the += operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<Position> for Address

fn from(p: Position) -> Self

Converts to this type from the input type.

impl From<Position> for u64

fn from(p: Position) -> Self

Converts to this type from the input type.

impl From<u64> for Position

fn from(sz: u64) -> Self

Converts to this type from the input type.

impl Hash for Position

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 Position

fn cmp(&self, other: &Position) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Position

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

fn partial_cmp(&self, other: &Position) -> 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 Sub<u64> for Position

type Output = Position

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<Position> for usize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for Position

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position