Enum LockTime

pub enum LockTime {
    Height(Height),
    Time(DateTime<Utc>),
}

A Bitcoin-style locktime, representing either a block height or an epoch time.

Invariants

Users should not construct a LockTime with:

• a block::Height greater than LockTime::MAX_HEIGHT,
• a timestamp before 6 November 1985 (Unix timestamp less than LockTime::MIN_TIMESTAMP), or
• a timestamp after 5 February 2106 (Unix timestamp greater than LockTime::MAX_TIMESTAMP).

Variants

Height(Height)

The transaction can only be included in a block if the block height is strictly greater than this height

Time(DateTime<Utc>)

The transaction can only be included in a block if the block time is strictly greater than this timestamp

Implementations

impl LockTime

pub const MIN_TIMESTAMP: i64 = 500_000_000i64

The minimum LockTime::Time, as a Unix timestamp in seconds.

Users should not construct LockTimes with LockTime::Time lower than LockTime::MIN_TIMESTAMP.

If a LockTime is supposed to be lower than LockTime::MIN_TIMESTAMP, then a particular LockTime::Height applies instead, as described in the spec.

pub const MAX_TIMESTAMP: i64 = 4_294_967_295i64

The maximum LockTime::Time, as a timestamp in seconds.

Users should not construct lock times with timestamps greater than LockTime::MAX_TIMESTAMP. LockTime is u32 in the spec, so times are limited to u32::MAX.

pub const MAX_HEIGHT: Height = _

The maximum LockTime::Height, as a block height.

Users should not construct lock times with a block height greater than LockTime::MAX_TIMESTAMP.

If a LockTime is supposed to be greater than LockTime::MAX_HEIGHT, then a particular LockTime::Time applies instead, as described in the spec.

pub fn unlocked() -> Self

Returns a LockTime that is always unlocked.

The lock time is set to the block height of the genesis block.

pub fn min_lock_time_timestamp() -> LockTime

Returns the minimum LockTime::Time, as a LockTime.

Users should not construct lock times with timestamps lower than the value returned by this function.

pub fn max_lock_time_timestamp() -> LockTime

Returns the maximum LockTime::Time, as a LockTime.

Users should not construct lock times with timestamps greater than the value returned by this function.

pub fn is_time(&self) -> bool

Returns true if this lock time is a LockTime::Time, or false if it is a LockTime::Height.

Trait Implementations

impl Arbitrary for LockTime

Generates arbitrary LockTimes.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<LockTime>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: ()) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for LockTime

fn clone(&self) -> LockTime

Returns a copy of the value.

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<'de> Deserialize<'de> for LockTime

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LockTime

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ZcashDeserialize for LockTime

fn zcash_deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Try to read self from the given reader.

impl ZcashSerialize for LockTime

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

Write self to the given writer using the canonical format.

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

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl Copy for LockTime

impl Eq for LockTime

impl StructuralPartialEq for LockTime