Struct Height

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

Available on crate feature alloc only.

A relative lock time lock-by-blockheight value.

Implementations

impl Height

pub const ZERO: Self = _

Relative block height 0, can be included in any block.

pub const MIN: Self = Self::ZERO

The minimum relative block height (0), can be included in any block.

pub const MAX: Self = _

The maximum relative block height.

pub const fn from_height(blocks: u16) -> Self

Create a Height using a count of blocks.

pub const fn value(self) -> u16

Returns the inner u16 value.

pub const fn to_consensus_u32(&self) -> u32

Returns the u32 value used to encode this locktime in an nSequence field or argument to OP_CHECKSEQUENCEVERIFY.

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

fn default() -> Height

Returns the “default value” for a type.

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

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 BlockInterval

fn from(h: Height) -> Self

Converts a locktime::relative::Height to a BlockInterval.

A relative locktime block height has a maximum value of u16::MAX where as a BlockInterval is a thin wrapper around a u32, the two types are not interchangeable.

impl From<u16> for Height

fn from(value: u16) -> Self

Converts to this type from the input type.

impl FromStr for Height

type Err = ParseIntError

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<__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 = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BlockInterval> for Height

fn try_from(h: BlockInterval) -> Result<Self, Self::Error>

Converts a BlockInterval to a locktime::relative::Height.

A relative locktime block height has a maximum value of u16::MAX where as a BlockInterval is a thin wrapper around a u32, the two types are not interchangeable.

type Error = TooBigForRelativeBlockHeightError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for Height

type Error = ParseIntError

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

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