Struct NumberOfBlocks 

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

A relative lock time lock-by-height value.

Implementations

impl NumberOfBlocks

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

Constructs a new NumberOfBlocks using a count of blocks.

pub const fn to_height(self) -> u16

Express the NumberOfBlocks as a count of blocks.

pub const fn to_consensus_u32(self) -> u32

👎Deprecated since 1.0.0-rc.0: use LockTime::from followed by to_consensus_u32 instead

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

pub fn is_satisfied_by( self, chain_tip: BlockHeight, utxo_mined_at: BlockHeight, ) -> Result<bool, InvalidHeightError>

Returns true if an output locked by height can be spent in the next block.

Errors

If chain_tip as not after utxo_mined_at i.e., if you get the args mixed up.

Trait Implementations

impl<'a> Arbitrary<'a> for NumberOfBlocks

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 NumberOfBlocks

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

Formats the value using the given formatter.

impl Clone for NumberOfBlocks

fn clone(&self) -> NumberOfBlocks

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NumberOfBlocks

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

Formats the value using the given formatter.

impl Default for NumberOfBlocks

fn default() -> NumberOfBlocks

Returns the “default value” for a type.

impl Display for NumberOfBlocks

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

Formats the value using the given formatter.

impl From<NumberOfBlocks> for BlockHeightInterval

fn from(h: NumberOfBlocks) -> Self

Converts a locktime::relative::NumberOfBlocks to a BlockHeightInterval.

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

impl From<NumberOfBlocks> for LockTime

fn from(h: NumberOfBlocks) -> Self

Converts to this type from the input type.

impl From<u16> for NumberOfBlocks

fn from(value: u16) -> Self

Converts to this type from the input type.

impl FromStr for NumberOfBlocks

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 NumberOfBlocks

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 NumberOfBlocks

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

Formats the value using the given formatter.

impl Octal for NumberOfBlocks

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

Formats the value using the given formatter.

impl Ord for NumberOfBlocks

fn cmp(&self, other: &NumberOfBlocks) -> 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 NumberOfBlocks

fn eq(&self, other: &NumberOfBlocks) -> 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 NumberOfBlocks

fn partial_cmp(&self, other: &NumberOfBlocks) -> 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 NumberOfBlocks

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<BlockHeightInterval> for NumberOfBlocks

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

Converts a BlockHeightInterval to a locktime::relative::NumberOfBlocks.

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

type Error = TooBigForRelativeHeightError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for NumberOfBlocks

Available on crate feature alloc only.

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 NumberOfBlocks

Available on crate feature alloc only.

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

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

Formats the value using the given formatter.

impl Copy for NumberOfBlocks

impl Eq for NumberOfBlocks

impl StructuralPartialEq for NumberOfBlocks