Struct Height 

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

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>

Constructs a new Height from a hex string.

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

Errors

If the input string is not a valid hex representation of a block height.

pub const fn from_u32(n: u32) -> Result<Self, ConversionError>

Constructs a new block height directly from a u32 value.

Errors

If n does not represent a block height within the valid range for a locktime: [0, 499_999_999].

Examples

use bitcoin_units::locktime::absolute;

let h: u32 = 741521;
let height = absolute::Height::from_u32(h)?;
assert_eq!(height.to_u32(), h);

pub const fn to_u32(self) -> u32

Converts this Height to a raw u32 value.

Examples

use bitcoin_units::locktime::absolute;

assert_eq!(absolute::Height::MAX.to_u32(), 499_999_999);

pub fn is_satisfied_by(self, height: Self) -> bool

Returns true if a transaction with this locktime can be included in the next block.

self is value of the LockTime and if height is the current chain tip then a transaction with this lock can be broadcast for inclusion in the next block.

Trait Implementations

impl<'a> Arbitrary<'a> for Height

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

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 Height

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

Formats the value using the given formatter.

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 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 minus one, while BlockHeight may take the full range of u32.

impl From<Height> for LockTime

fn from(h: Height) -> Self

Converts to this type from the input type.

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

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

Formats the value using the given formatter.

impl Octal for Height

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl Copy for Height

impl Eq for Height

impl StructuralPartialEq for Height