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: Height

Absolute block height 0, the genesis block.

pub const MIN: Height = Self::ZERO

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

pub const MAX: Height

The maximum absolute block height.

pub const fn min_value() -> Height

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

This is provided for consistency with Rust 1.41.1, newer code should use Height::MIN.

pub const fn max_value() -> Height

The maximum absolute block height.

This is provided for consistency with Rust 1.41.1, newer code should use Height::MAX.

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

Constructs a new block height.

Errors

If n does not represent a block height value (see documentation on LockTime).

Examples

use bitcoin::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 fn to_consensus_u32(self) -> u32

Converts this Height to its inner u32 value.

Examples

use bitcoin::absolute::LockTime;

let n_lock_time: u32 = 741521;
let lock_time = LockTime::from_consensus(n_lock_time);
assert!(lock_time.is_block_height());
assert_eq!(lock_time.to_consensus_u32(), n_lock_time);

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Height

fn deserialize<__D>( __deserializer: __D, ) -> Result<Height, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Height

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

Formats the value using the given formatter.

impl From<Height> for LockTime

fn from(h: Height) -> LockTime

Converts to this type from the input type.

impl FromHexStr for Height

type Error = Error

An error occurred while parsing the hex string.

fn from_hex_str_no_prefix<S>( s: S, ) -> Result<Height, <Height as FromHexStr>::Error>

where S: AsRef<str> + Into<String>,

Parses provided string as hex without requiring 0x prefix.

fn from_hex_str<S>(s: S) -> Result<Self, FromHexError<Self::Error>>

where S: AsRef<str> + Into<String>,

Parses provided string as hex requiring 0x prefix.

impl FromStr for Height

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Height, <Height as FromStr>::Err>

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

impl Hash for Height

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 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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Height

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Height, <Height as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Box<str>> for Height

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Height

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Height

impl Eq for Height

impl StructuralPartialEq for Height