Struct BlockHeight

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

A wrapper type representing blockchain heights.

Safe conversion from various integer types, as well as addition and subtraction, are provided.

Implementations

impl BlockHeight

pub const fn from_u32(v: u32) -> BlockHeight

pub fn saturating_sub(self, v: u32) -> BlockHeight

Subtracts the provided value from this height, returning H0 if this would result in underflow of the wrapped u32.

Trait Implementations

impl Add<u32> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for BlockHeight

fn clone(&self) -> BlockHeight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockHeight

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

Formats the value using the given formatter.

impl Display for BlockHeight

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

Formats the value using the given formatter.

impl DynamicUsage for BlockHeight

fn dynamic_usage(&self) -> usize

Returns a best estimate of the amount of heap-allocated memory used by this type.

fn dynamic_usage_bounds(&self) -> (usize, Option<usize>)

Returns the lower and upper bounds on the amount of heap-allocated memory used by this type.

impl From<BlockHeight> for i64

fn from(value: BlockHeight) -> i64

Converts to this type from the input type.

impl From<BlockHeight> for u32

fn from(value: BlockHeight) -> u32

Converts to this type from the input type.

impl From<BlockHeight> for u64

fn from(value: BlockHeight) -> u64

Converts to this type from the input type.

impl From<u32> for BlockHeight

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for BlockHeight

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 BlockHeight

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 PartialEq for BlockHeight

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

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 Sub<u32> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for BlockHeight

type Output = u32

The resulting type after applying the - operator.

fn sub(self, other: BlockHeight) -> u32

Performs the - operation.

impl TestCheckpoint for BlockHeight

Available on crate feature test-dependencies only.

fn from_u64(value: u64) -> Self

impl TryFrom<i32> for BlockHeight

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for BlockHeight

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for BlockHeight

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BlockHeight

impl Eq for BlockHeight

impl StructuralPartialEq for BlockHeight