Struct BlockHeight 

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

A block height. Zero denotes the genesis block.

This type is not meant for constructing height based timelocks. It is a general purpose blockheight 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.

Implementations

impl BlockHeight

pub fn from_hex(s: &str) -> Result<BlockHeight, PrefixedHexError>

Constructs a new BlockHeight from an unprefixed hex string.

Errors

If the input string is not a valid hex representation of a BlockHeight or it does not include the 0x prefix.

pub fn from_unprefixed_hex(s: &str) -> Result<BlockHeight, UnprefixedHexError>

Constructs a new BlockHeight from a prefixed hex string.

Errors

If the input string is not a valid hex representation of a BlockHeight or if it includes the 0x prefix.

impl BlockHeight

pub const ZERO: BlockHeight

Block height 0, the genesis block.

pub const MIN: BlockHeight = Self::ZERO

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

pub const MAX: BlockHeight

The maximum block height.

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

Constructs a new block height from a u32.

pub const fn to_u32(self) -> u32

Returns block height as a u32.

pub fn checked_sub(self, other: BlockHeight) -> Option<BlockHeightInterval>

Attempt to subtract two BlockHeights, returning None if overflow occurred.

pub fn checked_add(self, other: BlockHeightInterval) -> Option<BlockHeight>

Attempt to add an interval to this BlockHeight, returning None if overflow occurred.

pub const fn saturating_add(self, rhs: BlockHeightInterval) -> BlockHeight

Saturating integer addition.

Computes self + rhs, saturating at BlockHeight::MAX instead of overflowing.

pub const fn saturating_sub(self, rhs: BlockHeightInterval) -> BlockHeight

Saturating integer subtraction.

Computes self - rhs, saturating at BlockHeight::MIN instead of overflowing.

Trait Implementations

impl<'a> Add<&'a BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <&BlockHeight as Add<&'a BlockHeightInterval>>::Output

Performs the + operation.

impl Add<&BlockHeightInterval> for BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: &BlockHeightInterval, ) -> <BlockHeight as Add<&BlockHeightInterval>>::Output

Performs the + operation.

impl Add<BlockHeightInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the + operator.

fn add( self, rhs: BlockHeightInterval, ) -> <BlockHeight as Add<BlockHeightInterval>>::Output

Performs the + operation.

impl Add<BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Add<BlockHeightInterval>>::Output

The resulting type after applying the + operator.

fn add( self, rhs: BlockHeightInterval, ) -> <&BlockHeight as Add<BlockHeightInterval>>::Output

Performs the + operation.

impl<'a> Arbitrary<'a> for BlockHeight

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<BlockHeight, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Binary for BlockHeight

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

Formats the value using the given formatter.

impl Clone for BlockHeight

fn clone(&self) -> BlockHeight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockHeight

impl Debug for BlockHeight

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

Formats the value using the given formatter.

impl Decode for BlockHeight

Available on crate feature encoding only.

type Decoder = BlockHeightDecoder

Associated decoder for the type.

fn decoder() -> Self::Decoder

Constructs a “default decoder” for the type.

impl<'de> Deserialize<'de> for BlockHeight

Available on crate feature serde only.

fn deserialize<D>(d: D) -> Result<BlockHeight, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHeight

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

Formats the value using the given formatter.

impl Encode for BlockHeight

Available on crate feature encoding only.

type Encoder<'e> = BlockHeightEncoder<'e>

The encoder associated with this type. Conceptually, the encoder is like an iterator which yields byte slices.

fn encoder(&self) -> <BlockHeight as Encode>::Encoder<'_>

Constructs a “default encoder” for the type.

impl Eq for BlockHeight

impl From<BlockHeight> for u32

fn from(height: BlockHeight) -> u32

Converts to this type from the input type.

impl From<Height> for BlockHeight

fn from(h: Height) -> BlockHeight

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

An absolute locktime block height has a maximum value of absolute::LOCK_TIME_THRESHOLD minus one, while BlockHeight may take the full range of u32.

impl From<u32> for BlockHeight

fn from(inner: u32) -> BlockHeight

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<BlockHeight, <BlockHeight as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for BlockHeight

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

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

Formats the value using the given formatter.

impl Octal for BlockHeight

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

Formats the value using the given formatter.

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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

Available on crate feature serde only.

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BlockHeight

impl Sub for BlockHeight

type Output = BlockHeightInterval

The resulting type after applying the - operator.

fn sub(self, rhs: BlockHeight) -> <BlockHeight as Sub>::Output

Performs the - operation.

impl<'a> Sub<&'a BlockHeight> for &BlockHeight

type Output = <BlockHeight as Sub>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeight, ) -> <&BlockHeight as Sub<&'a BlockHeight>>::Output

Performs the - operation.

impl<'a> Sub<&'a BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <&BlockHeight as Sub<&'a BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<&BlockHeight> for BlockHeight

type Output = <BlockHeight as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &BlockHeight) -> <BlockHeight as Sub<&BlockHeight>>::Output

Performs the - operation.

impl Sub<&BlockHeightInterval> for BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: &BlockHeightInterval, ) -> <BlockHeight as Sub<&BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<BlockHeight> for &BlockHeight

type Output = <BlockHeight as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: BlockHeight) -> <&BlockHeight as Sub<BlockHeight>>::Output

Performs the - operation.

impl Sub<BlockHeightInterval> for BlockHeight

type Output = BlockHeight

The resulting type after applying the - operator.

fn sub( self, rhs: BlockHeightInterval, ) -> <BlockHeight as Sub<BlockHeightInterval>>::Output

Performs the - operation.

impl Sub<BlockHeightInterval> for &BlockHeight

type Output = <BlockHeight as Sub<BlockHeightInterval>>::Output

The resulting type after applying the - operator.

fn sub( self, rhs: BlockHeightInterval, ) -> <&BlockHeight as Sub<BlockHeightInterval>>::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<BlockHeight, <BlockHeight as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<BlockHeight> for Height

fn try_from( h: BlockHeight, ) -> Result<Height, <Height as TryFrom<BlockHeight>>::Error>

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

An absolute locktime block height has a maximum value of absolute::LOCK_TIME_THRESHOLD minus one, while BlockHeight may take the full range of u32.

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for BlockHeight

Available on crate feature alloc only.

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( s: Box<str>, ) -> Result<BlockHeight, <BlockHeight as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<String> for BlockHeight

Available on crate feature alloc only.

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<BlockHeight, <BlockHeight as TryFrom<String>>::Error>

Performs the conversion.

impl UpperHex for BlockHeight

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

Formats the value using the given formatter.