Struct Height

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

Available on crate feature alloc only.

An absolute block height, guaranteed to always contain a valid height value.

Implementations

impl Height

pub const ZERO: Self = _

Absolute block height 0, the genesis block.

pub const MIN: Self = Self::ZERO

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

pub const MAX: Self = _

The maximum absolute block height.

pub fn from_hex(s: &str) -> Result<Self, ParseHeightError>

Creates a Height from a hex string.

The input string may or may not contain a typical hex prefix e.g., 0x.

pub const fn from_consensus(n: u32) -> Result<Height, ConversionError>

Constructs a new block height.

Errors

If n does not represent a valid block height value.

Examples

use bitcoin_units::locktime::absolute::Height;

let h: u32 = 741521;
let height = Height::from_consensus(h).expect("invalid height value");
assert_eq!(height.to_consensus_u32(), h);

pub const fn to_consensus_u32(self) -> u32

Converts this Height to its inner u32 value.

Trait Implementations

impl Clone for Height

fn clone(&self) -> Height

Returns a copy 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<'de> Deserialize<'de> for Height

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Height

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

Formats the value using the given formatter.

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 FromStr for Height

type Err = ParseHeightError

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 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 Serialize for Height

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Height

type Error = ParseHeightError

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 Height

type Error = ParseHeightError

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 Height

type Error = ParseHeightError

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 Height

impl Eq for Height

impl StructuralPartialEq for Height