Struct bpstd::LockHeight

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

Value for a transaction nTimeLock field which is guaranteed to represent a block height number which is always less than 500000000.

Implementations

impl LockHeight

pub fn anytime() -> LockHeight

Create zero time lock

pub fn from_height(height: u32) -> Option<LockHeight>

Creates absolute time lock with the given block height.

Block height must be strictly less than 0x1DCD6500, otherwise None is returned.

pub const fn try_from_lock_time( lock_time: LockTime ) -> Result<LockHeight, InvalidTimelock>

pub const fn try_from_consensus_u32( lock_time: u32 ) -> Result<LockHeight, InvalidTimelock>

pub const fn to_consensus_u32(&self) -> u32

Converts into full u32 representation of nLockTime value as it is serialized in bitcoin transaction.

pub const fn into_consensus_u32(self) -> u32

Converts into full u32 representation of nLockTime value as it is serialized in bitcoin transaction.

pub fn to_lock_time(&self) -> LockTime

Converts into LockTime representation.

pub fn into_lock_time(self) -> LockTime

Converts into LockTime representation.

Trait Implementations

impl Clone for LockHeight

fn clone(&self) -> LockHeight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockHeight

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

Formats the value using the given formatter.

impl Decode for LockHeight

fn decode(reader: &mut impl Read) -> Result<LockHeight, DecodeError>

fn deserialize(bytes: impl AsRef<[u8]>) -> Result<Self, PsbtError>

impl Default for LockHeight

fn default() -> LockHeight

Returns the “default value” for a type.

impl Display for LockHeight

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

Formats the value using the given formatter.

impl Encode for LockHeight

fn encode(&self, writer: &mut dyn Write) -> Result<usize, IoError>

impl From<LockHeight> for LockTime

fn from(lock: LockHeight) -> LockTime

Converts to this type from the input type.

impl FromStr for LockHeight

type Err = TimelockParseError

The associated error which can be returned from parsing.

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

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

impl Hash for LockHeight

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 LockHeight

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

Restrict a value to a certain interval.

impl PartialEq for LockHeight

fn eq(&self, other: &LockHeight) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LockHeight

fn partial_cmp(&self, other: &LockHeight) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StrictDecode for LockHeight

fn strict_decode(reader: &mut impl TypedRead) -> Result<LockHeight, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictEncode for LockHeight

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for LockHeight

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for LockHeight

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl TryFrom<LockTime> for LockHeight

type Error = InvalidTimelock

The type returned in the event of a conversion error.

fn try_from( lock_time: LockTime ) -> Result<LockHeight, <LockHeight as TryFrom<LockTime>>::Error>

Performs the conversion.

impl TryFrom<u32> for LockHeight

type Error = InvalidTimelock

The type returned in the event of a conversion error.

fn try_from( value: u32 ) -> Result<LockHeight, <LockHeight as TryFrom<u32>>::Error>

Performs the conversion.

impl Copy for LockHeight

impl Eq for LockHeight

impl StrictProduct for LockHeight

impl StructuralPartialEq for LockHeight