Struct Sequence 

pub struct Sequence(pub u32);

Bitcoin transaction input sequence number.

Tuple Fields

0: u32

Implementations

impl Sequence

pub const MAX: Self

The maximum allowable sequence number.

The sequence number that disables replace-by-fee, absolute lock time and relative lock time.

pub const ZERO: Self

Zero value sequence.

This sequence number enables replace-by-fee and absolute lock time.

pub const FINAL: Self = Sequence::MAX

The sequence number that disables replace-by-fee, absolute lock time and relative lock time.

pub const ENABLE_LOCKTIME_NO_RBF: Self = Sequence::MIN_NO_RBF

The sequence number that enables absolute lock time but disables replace-by-fee and relative lock time.

pub const ENABLE_RBF_NO_LOCKTIME: Self

👎Deprecating in a future version: use ENABLE_LOCKTIME_AND_RBF instead

The sequence number that enables replace-by-fee and absolute lock time but disables relative lock time.

pub const ENABLE_LOCKTIME_AND_RBF: Self

The maximum sequence number that enables replace-by-fee and absolute lock time but disables relative lock time.

This sequence number has no meaning other than to enable RBF and the absolute locktime.

pub const SIZE: usize = 4usize

The number of bytes that a sequence number contributes to the size of a transaction.

pub fn enables_absolute_lock_time(&self) -> bool

Returns true if the sequence number enables absolute lock-time (Transaction::lock_time).

pub fn is_final(&self) -> bool

Returns true if the sequence number indicates that the transaction is finalized.

Instead of this method please consider using !enables_absolute_lock_time because it is equivalent and improves readability for those not steeped in Bitcoin folklore.

Historical note

The term ‘final’ is an archaic Bitcoin term, it may have come about because the sequence number in the original Bitcoin code was intended to be incremented in order to replace a transaction, so once the sequence number got to u64::MAX it could no longer be increased, hence it was ‘final’.

Some other references to the term:

• CTxIn::SEQUENCE_FINAL in the Bitcoin Core code.
• BIP-112: “BIP 68 prevents a non-final transaction from being selected for inclusion in a block until the corresponding input has reached the specified age”

pub fn is_rbf(&self) -> bool

Returns true if the transaction opted-in to BIP125 replace-by-fee.

Replace by fee is signaled by the sequence being less than 0xfffffffe which is checked by this method. Note, this is the highest “non-final” value (see Sequence::is_final).

pub fn is_relative_lock_time(&self) -> bool

Returns true if the sequence has a relative lock-time.

pub fn is_height_locked(&self) -> bool

Returns true if the sequence number encodes a block based relative lock-time.

pub fn is_time_locked(&self) -> bool

Returns true if the sequence number encodes a time interval based relative lock-time.

pub fn from_hex(s: &str) -> Result<Self, PrefixedHexError>

Available on crate feature alloc only.

Constructs a new Sequence from a prefixed hex string.

pub fn from_unprefixed_hex(s: &str) -> Result<Self, UnprefixedHexError>

Available on crate feature alloc only.

Constructs a new Sequence from an unprefixed hex string.

pub fn from_height(height: u16) -> Self

Constructs a new relative lock-time using block height.

pub fn from_512_second_intervals(intervals: u16) -> Self

Constructs a new relative lock-time using time intervals where each interval is equivalent to 512 seconds.

Encoding finer granularity of time for relative lock-times is not supported in Bitcoin

pub fn from_seconds_floor(seconds: u32) -> Result<Self, TimeOverflowError>

Available on crate feature alloc only.

Constructs a new relative lock-time from seconds, converting the seconds into 512 second interval with floor division.

Will return an error if the input cannot be encoded in 16 bits.

pub fn from_seconds_ceil(seconds: u32) -> Result<Self, TimeOverflowError>

Available on crate feature alloc only.

Constructs a new relative lock-time from seconds, converting the seconds into 512 second interval with ceiling division.

Will return an error if the input cannot be encoded in 16 bits.

pub fn from_consensus(n: u32) -> Self

Constructs a new sequence from a u32 value.

pub fn to_consensus_u32(self) -> u32

Returns the inner 32bit integer value of Sequence.

pub fn to_relative_lock_time(&self) -> Option<LockTime>

Available on crate feature alloc only.

Constructs a new relative::LockTime from this Sequence number.

impl Sequence

pub fn to_hex(&self) -> String

Available on crate feature alloc only.

Gets the hex representation of this type

Trait Implementations

impl<'a> Arbitrary<'a> for Sequence

Available on crate features arbitrary and alloc 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 Clone for Sequence

fn clone(&self) -> Sequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sequence

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

Formats the value using the given formatter.

impl Default for Sequence

fn default() -> Self

The default value of sequence is 0xffffffff.

impl<'de> Deserialize<'de> for Sequence

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Sequence

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

Formats the value using the given formatter.

impl From<LockTime> for Sequence

Available on crate feature alloc only.

fn from(lt: LockTime) -> Sequence

Converts to this type from the input type.

impl From<Sequence> for u32

fn from(sequence: Sequence) -> u32

Converts to this type from the input type.

impl FromStr for Sequence

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 Sequence

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 Sequence

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

Formats the value using the given formatter.

impl Ord for Sequence

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Sequence

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<Box<str>> for Sequence

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

Available on crate feature alloc only.

type Error = DisabledLockTimeError

The type returned in the event of a conversion error.

fn try_from(seq: Sequence) -> Result<LockTime, DisabledLockTimeError>

Performs the conversion.

impl TryFrom<String> for Sequence

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 Sequence

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

Formats the value using the given formatter.

impl Copy for Sequence

impl Eq for Sequence

impl StructuralPartialEq for Sequence