Struct PackedLockTime

pub struct PackedLockTime(pub u32);

Packed lock time wraps a LockTime consensus value i.e., the raw u32 used by the network.

This struct may be preferred in performance-critical applications because it’s slightly smaller than LockTime and has a bit more performant (de)serialization. In particular, this may be relevant when the value is not processed, just passed around. Note however that the difference is super-small, so unless you do something extreme you shouldn’t worry about it.

This type implements a naive ordering based on the u32, this is not a semantically correct ordering for a lock time, hence LockTime does not implement Ord. This type is useful if you want to use a lock time as part of a struct and wish to derive Ord. For all other uses, consider using LockTime directly.

Examples

#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
struct S {
    lock_time: PackedLockTime,
    amount: Amount,
}

let _ = S {
    lock_time: LockTime::from_consensus(741521).into(),
    amount: Amount::from_sat(10_000_000),
};

Tuple Fields

0: u32

Implementations

impl PackedLockTime

pub const ZERO: PackedLockTime = _

If crate::Transaction::lock_time is set to zero it is ignored, in other words a transaction with nLocktime==0 is able to be included immediately in any block.

pub fn to_u32(self) -> u32

Returns the inner u32.

Trait Implementations

impl Clone for PackedLockTime

fn clone(&self) -> PackedLockTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackedLockTime

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

Formats the value using the given formatter.

impl Decodable for PackedLockTime

fn consensus_decode<R>(r: &mut R) -> Result<PackedLockTime, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

impl Display for PackedLockTime

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

Formats the value using the given formatter.

impl Encodable for PackedLockTime

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>

where W: Write + ?Sized,

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl From<&LockTime> for PackedLockTime

fn from(n: &LockTime) -> PackedLockTime

Converts to this type from the input type.

impl From<&PackedLockTime> for LockTime

fn from(n: &PackedLockTime) -> LockTime

Converts to this type from the input type.

impl From<LockTime> for PackedLockTime

fn from(n: LockTime) -> PackedLockTime

Converts to this type from the input type.

impl From<PackedLockTime> for LockTime

fn from(n: PackedLockTime) -> LockTime

Converts to this type from the input type.

impl From<PackedLockTime> for u32

fn from(p: PackedLockTime) -> u32

Converts to this type from the input type.

impl FromStr for PackedLockTime

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for PackedLockTime

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 LowerHex for PackedLockTime

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

Formats the value using the given formatter.

impl Ord for PackedLockTime

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

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

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

type Error = ParseIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Box<str>> for PackedLockTime

type Error = ParseIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for PackedLockTime

type Error = ParseIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for PackedLockTime

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

Formats the value using the given formatter.

impl Copy for PackedLockTime

impl Eq for PackedLockTime

impl StructuralPartialEq for PackedLockTime