SeqNo

Struct SeqNo 

Source
pub struct SeqNo(/* private fields */);
Expand description

Value for nSeq field of a transaction output

Implementations§

Source§

impl SeqNo

Source

pub fn unencumbered(max: bool) -> SeqNo

Creates nSeq value which is not encumbered by either RBF not relative time locks.

§Arguments
  • max defines whether nSeq should be set to the 0xFFFFFFFF (true) or 0xFFFFFFFe.
Source

pub fn from_rbf(order: u16) -> SeqNo

Creates nSeq in replace-by-fee mode with the specified order number.

Source

pub fn rbf() -> SeqNo

Creates nSeq in replace-by-fee mode with value 0xFFFFFFFD.

This value is the value supported by the BitBox software.

Source

pub fn from_height(blocks: u16) -> SeqNo

Creates relative time lock measured in number of blocks (implies RBF).

Source

pub fn from_intervals(intervals: u16) -> SeqNo

Creates relative time lock measured in number of 512-second intervals (implies RBF).

Source

pub fn from_consensus(consensus: u32) -> SeqNo

Creates time lock basing on bitcoin consensus 32-bit value.

Source

pub fn classify(self) -> SeqNoClass

Classifies type of nSeq value (see SeqNoClass).

Source

pub fn is_rbf(self) -> bool

Checks if nSeq value opts-in for replace-by-fee (also always true for relative time locks).

Source

pub fn is_timelock(self) -> bool

Checks if nSeq value opts-in for relative time locks (also always imply RBG opt-in).

Source

pub fn into_consensus(self) -> u32

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

Source

pub fn time_lock_interval(self) -> Option<TimeLockInterval>

Gets structured relative time lock information from the nSeq value. See TimeLockInterval.

Trait Implementations§

Source§

impl Clone for SeqNo

Source§

fn clone(&self) -> SeqNo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SeqNo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SeqNo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for SeqNo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SeqNo> for u32

Source§

fn from(seqno: SeqNo) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for SeqNo

Source§

fn from(v: u32) -> Self

Converts to this type from the input type.
Source§

impl FromStr for SeqNo

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for SeqNo

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SeqNo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for SeqNo

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StrictDecode for SeqNo

Source§

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.
Source§

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.
Source§

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.
Source§

impl StrictEncode for SeqNo

Source§

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.
Source§

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

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

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.
Source§

impl Copy for SeqNo

Source§

impl Eq for SeqNo

Source§

impl StructuralPartialEq for SeqNo

Auto Trait Implementations§

§

impl Freeze for SeqNo

§

impl RefUnwindSafe for SeqNo

§

impl Send for SeqNo

§

impl Sync for SeqNo

§

impl Unpin for SeqNo

§

impl UnwindSafe for SeqNo

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.