Struct incrementalmerkletree::Address

pub struct Address { /* private fields */ }

The address of a node of the Merkle tree. When level == 0, the index has the same value as the position.

Implementations

impl Address

pub fn from_parts(level: Level, index: u64) -> Self

Construct a new address from its constituent parts.

pub fn above_position(level: Level, position: Position) -> Self

Returns the address at the given level that contains the specified leaf position.

pub fn level(&self) -> Level

Returns the level of the root of the tree having its root at this address.

pub fn index(&self) -> u64

Returns the index of the address.

The index of an address is defined as the number of subtrees with their roots at the address’s level that appear to the left of this address in a binary tree of arbitrary height > level * 2 + 1.

pub fn parent(&self) -> Address

The address of the node one level higher than this in a binary tree that contains this address as either its left or right child.

pub fn sibling(&self) -> Address

Returns the address that shares the same parent as this address.

pub fn children(&self) -> Option<(Address, Address)>

Returns the immediate children of this address.

pub fn is_ancestor_of(&self, addr: &Self) -> bool

Returns whether this address is an ancestor of the specified address.

pub fn common_ancestor(&self, other: &Self) -> Self

Returns the common ancestor of self and other having the smallest level value.

pub fn contains(&self, addr: &Self) -> bool

Returns whether this address is an ancestor of, or is equal to, the specified address.

pub fn position_range_start(&self) -> Position

Returns the minimum value among the range of leaf positions that are contained within the tree with its root at this address.

pub fn position_range_end(&self) -> Position

Returns the (exclusive) end of the range of leaf positions that are contained within the tree with its root at this address.

pub fn max_position(&self) -> Position

Returns the maximum value among the range of leaf positions that are contained within the tree with its root at this address.

pub fn position_range(&self) -> Range<Position>

Returns the end-exclusive range of leaf positions that are contained within the tree with its root at this address.

pub fn context(&self, level: Level) -> Either<Address, Range<u64>>

Returns either the ancestor of this address at the given level (if the level is greater than or equal to that of this address) or the range of indices of root addresses of subtrees with roots at the given level contained within the tree with its root at this address otherwise.

pub fn position_cmp(&self, pos: Position) -> Ordering

Returns whether the tree with this root address contains the given leaf position, or if not whether an address at the same level with a greater or lesser index will contain the specified leaf position.

pub fn is_left_child(&self) -> bool

Returns whether this address is the left-hand child of its parent

pub fn is_right_child(&self) -> bool

Returns whether this address is the right-hand child of its parent

pub fn current_incomplete(&self) -> Address

pub fn next_incomplete_parent(&self) -> Address

pub fn next_at_level(&self) -> Address

Increments this address’s index by 1 and returns the resulting address.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

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

fn from(addr: &'a Address) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Address> for Option<Position>

fn from(addr: Address) -> 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 Hash for Address

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 Address

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

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

fn partial_cmp(&self, other: &Address) -> 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 Copy for Address

impl Eq for Address

impl StructuralPartialEq for Address