Struct BlockHeight

pub struct BlockHeight(pub u32);

Available on crate feature alloc only.

The block height, zero denotes the genesis block.

This type is not meant for constructing height based timelocks, this is a general purpose block height abstraction. For locktimes please see locktime::absolute::Height.

This is a thin wrapper around a u32 that may take on all values of a u32.

Tuple Fields

0: u32

Implementations

impl BlockHeight

pub const ZERO: Self = _

Block height 0, the genesis block.

pub const MIN: Self = Self::ZERO

The minimum block height (0), the genesis block.

pub const MAX: Self = _

The maximum block height.

pub const fn from_u32(inner: u32) -> Self

Creates a block height from a u32.

pub const fn to_u32(&self) -> u32

Returns block height as a u32.

Trait Implementations

impl Add<BlockInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

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

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<'de> Deserialize<'de> for BlockHeight

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHeight

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

Formats the value using the given formatter.

impl From<BlockHeight> for u32

fn from(height: BlockHeight) -> Self

Converts to this type from the input type.

impl From<Height> for BlockHeight

fn from(h: Height) -> Self

Converts a locktime::absolute::Height to a BlockHeight.

An absolute locktime block height has a maximum value of absolute::LOCK_TIME_THRESHOLD (500,000,000) where as a BlockHeight is a thin wrapper around a u32, the two types are not interchangeable.

impl From<u32> for BlockHeight

fn from(inner: u32) -> Self

Converts to this type from the input type.

impl FromStr for BlockHeight

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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: &BlockHeight) -> 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: &BlockHeight) -> 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 Serialize for BlockHeight

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<BlockInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for BlockHeight

type Output = BlockInterval

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<&str> for BlockHeight

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BlockHeight> for Height

fn try_from(h: BlockHeight) -> Result<Self, Self::Error>

Converts a BlockHeight to a locktime::absolute::Height.

An absolute locktime block height has a maximum value of absolute::LOCK_TIME_THRESHOLD (500,000,000) where as a BlockHeight is a thin wrapper around a u32, the two types are not interchangeable.

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for BlockHeight

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for BlockHeight

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BlockHeight

impl Eq for BlockHeight

impl StructuralPartialEq for BlockHeight