Struct LockTime

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

Value for a transaction nTimeLock field, which can be either a timestamp (>=500000000) or a block height (<500000000). See alse LockTimestamp and LockHeight types.

Implementations

impl LockTime

pub fn anytime() -> Self

Create zero time lock

pub fn since_now() -> Self

Creates absolute time lock valid since the current timestamp.

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

Creates absolute time lock with the given block height.

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

pub fn from_unix_timestamp(timestamp: u32) -> Option<Self>

Creates absolute time lock with the given UNIX timestamp value.

Timestamp value must be greater or equal to 0x1DCD6500, otherwise None is returned.

pub fn from_consensus(value: u32) -> Self

Constructs timelock from a bitcoin consensus 32-bit timelock value.

pub fn is_height_based(self) -> bool

Checks if the absolute timelock provided by the nLockTime value specifies height-based lock

pub fn is_time_based(self) -> bool

Checks if the absolute timelock provided by the nLockTime value specifies time-based lock

pub fn into_consensus(self) -> u32

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

Trait Implementations

impl Clone for LockTime

fn clone(&self) -> LockTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockTime

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

Formats the value using the given formatter.

impl Default for LockTime

fn default() -> LockTime

Returns the “default value” for a type.

impl Display for LockTime

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

Formats the value using the given formatter.

impl From<LockHeight> for LockTime

fn from(v: LockHeight) -> Self

Converts to this type from the input type.

impl From<LockTime> for u32

fn from(lock_time: LockTime) -> Self

Converts to this type from the input type.

impl From<LockTimestamp> for LockTime

fn from(v: LockTimestamp) -> Self

Converts to this type from the input type.

impl From<u32> for LockTime

fn from(v: u32) -> Self

Converts to this type from the input type.

impl FromStr for LockTime

type Err = ParseError

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 LockTime

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 PartialEq for LockTime

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

Tests for self and other values to be equal, and is used by ==.

const 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 LockTime

fn partial_cmp(&self, other: &Self) -> 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 StrictDecode for LockTime

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

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for LockTime

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

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<Self, Self::Error>

Performs the conversion.

impl TryFrom<LockTime> for LockTimestamp

type Error = InvalidTimelock

The type returned in the event of a conversion error.

fn try_from(lock_time: LockTime) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for LockTime

impl Eq for LockTime

impl StructuralPartialEq for LockTime