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

Height zero

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 elements::locktime::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 elements::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

Formats the value using the given formatter.

impl Decodable for Height

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl Deserialize for Height

fn deserialize(bytes: &[u8]) -> Result<Self, Error>

Deserialize a value from raw data.

impl Display for Height

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

Formats the value using the given formatter.

impl Encodable for Height

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Write errors. Returns the number of bytes written on success

impl From<Height> for LockTime

fn from(h: Height) -> Self

Converts to this type from the input type.

impl FromStr for Height

type Err = Error

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

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl TryFrom<&str> for Height

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl Copy for Height

impl Eq for Height

impl StructuralPartialEq for Height