Struct Position 

pub struct Position<F: Family>(/* private fields */);

A Position is a node index or node count in a Merkle structure. This is in contrast to a Location, which is a leaf index or leaf count.

Limits

Values up to the family’s maximum are valid (see Position::is_valid). As a 0-based node index, valid indices are 0..MAX - 1. As a node count or total size, the maximum is MAX itself. Use Position::is_valid_size to ask whether a count is a structurally valid size for the specific Merkle family.

Implementations

impl<F: Family> Position<F>

pub const fn new(pos: u64) -> Self

Return a new Position from a raw u64.

pub const fn as_u64(self) -> u64

Return the underlying u64 value.

pub const fn is_valid(self) -> bool

Returns true iff this value is a valid node count or size (<= MAX_NODES).

pub const fn is_valid_index(self) -> bool

Returns true iff this value is a valid 0-based node index (< MAX_NODES).

pub const fn checked_add(self, rhs: u64) -> Option<Self>

Return self + rhs returning None on overflow or if result exceeds the maximum.

pub const fn checked_sub(self, rhs: u64) -> Option<Self>

Return self - rhs returning None on underflow.

pub const fn saturating_add(self, rhs: u64) -> Self

Return self + rhs saturating at the maximum.

pub const fn saturating_sub(self, rhs: u64) -> Self

Return self - rhs saturating at zero.

pub fn is_valid_size(self) -> bool

Returns whether this is a valid size for this Merkle structure.

Methods from Deref<Target = u64>

pub const MIN: u64 = 0

pub const MAX: u64

pub const BITS: u32

Trait Implementations

impl<F: Family> Add<u64> for Position<F>

Add a position and a u64.

Panics

Panics if the result overflows.

type Output = Position<F>

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl<F: Family> Add for Position<F>

Add two positions together.

Panics

Panics if the result overflows.

type Output = Position<F>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<F: Family> AddAssign<u64> for Position<F>

Add a u64 to a position.

Panics

Panics if the result overflows.

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl<F: Family> AsRef<u64> for Position<F>

fn as_ref(&self) -> &u64

Converts this type into a shared reference of the (usually inferred) input type.

impl<F: Family> Clone for Position<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Family> Debug for Position<F>

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

Formats the value using the given formatter.

impl<F: Family> Default for Position<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Family> Deref for Position<F>

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<F: Family> Display for Position<F>

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

Formats the value using the given formatter.

impl<F: Family> EncodeSize for Position<F>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl<F: Family> From<Position<F>> for u64

fn from(position: Position<F>) -> Self

Converts to this type from the input type.

impl<F: Family> From<u64> for Position<F>

fn from(value: u64) -> Self

Converts to this type from the input type.

impl<F: Family> From<usize> for Position<F>

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<F: Family> Hash for Position<F>

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<F: Family> Ord for Position<F>

fn cmp(&self, other: &Self) -> 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<F: Family> PartialEq<Position<F>> for u64

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

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

fn eq(&self, other: &Self) -> 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<F: Family> PartialOrd<Position<F>> for u64

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

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

fn partial_cmp(&self, other: &Self) -> 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<F: Family> Read for Position<F>

type Cfg = ()

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<F: Family> Sub<u64> for Position<F>

Subtract a u64 from a position.

Panics

Panics if the result underflows.

type Output = Position<F>

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl<F: Family> Sub for Position<F>

Subtract two positions.

Panics

Panics if the result underflows.

type Output = Position<F>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<F: Family> SubAssign<u64> for Position<F>

Subtract a u64 from a position.

Panics

Panics if the result underflows.

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl<F: Family> TryFrom<Location<F>> for Position<F>

Convert a leaf Location to its corresponding node Position.

Equivalently, convert a leaf count to the corresponding total node count (size).

Returns super::Error::LocationOverflow if !loc.is_valid().

type Error = Error<F>

The type returned in the event of a conversion error.

fn try_from(loc: Location<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: Family> TryFrom<Position<F>> for Location<F>

Attempt to derive the Location of a given node Position.

Equivalently, convert a total node count (size) to the corresponding leaf count.

Returns an error if pos exceeds the valid range or if it is neither a leaf position nor a valid size.

type Error = Error<F>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<F: Family> Write for Position<F>

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.

impl<F: Family> Copy for Position<F>

impl<F: Family> Eq for Position<F>