Struct Height 

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

Represents a sequential position in a chain or sequence.

Height is a monotonically increasing counter.

Implementations

impl Height

pub const fn zero() -> Self

Returns height zero.

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

Creates a new height from a u64 value.

pub const fn get(self) -> u64

Returns the underlying u64 value.

pub const fn is_zero(self) -> bool

Returns true if this is height zero.

pub const fn next(self) -> Self

Returns the next height.

Panics

Panics if the height would overflow u64::MAX. In practice, this is extremely unlikely to occur during normal operation.

pub fn previous(self) -> Option<Self>

Returns the previous height, or None if this is height zero.

Unlike Height::next(), this returns an Option since reaching height zero is common, whereas overflowing u64::MAX is not expected in normal operation.

pub const fn saturating_add(self, delta: HeightDelta) -> Self

Adds a height delta, saturating at u64::MAX.

pub const fn saturating_sub(self, delta: HeightDelta) -> Self

Subtracts a height delta, saturating at zero.

pub fn delta_from(self, other: Self) -> Option<HeightDelta>

Returns the delta from other to self, or None if other > self.

pub const fn range(start: Self, end: Self) -> HeightRange

Returns an iterator over the range [start, end).

If start >= end, returns an empty range.

Trait Implementations

impl Clone for Height

fn clone(&self) -> Height

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Height

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

Formats the value using the given formatter.

impl Default for Height

fn default() -> Height

Returns the “default value” for a type.

impl Display for Height

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

Formats the value using the given formatter.

impl EncodeSize for Height

fn encode_size(&self) -> usize

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

impl<D: Digest> From<Height> for Identifier<D>

fn from(src: Height) -> Self

Converts to this type from the input type.

impl From<Height> for U64

fn from(height: Height) -> Self

Converts to this type from the input type.

impl Hash for Height

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 Height

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

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

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

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, _cfg: &Self::Cfg) -> Result<Self, Error>

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

impl Write for Height

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

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

impl Copy for Height

impl Eq for Height

impl StructuralPartialEq for Height