Struct handshakes::types::txin::TxInput

pub struct TxInput<M> where
    M: MarkedDigestOutput,  {
    pub outpoint: Outpoint<M>,
    pub sequence: u32,
}

An TxInput. This data structure contains an outpoint referencing an existing UTXO, a sequence number which may encode relative locktim semantics in version 2+ transactions.

Sequence encoding is complex and the field also encodes information about locktimes and RBF. See James’ blogpost on the subject.

Fields

outpoint: Outpoint<M>

The Outpoint identifying the UTXO being spent.

sequence: u32

The nSequence field

Implementations

impl<M> TxInput<M> where
    M: MarkedDigestOutput, 

pub fn new(outpoint: Outpoint<M>, sequence: u32) -> Self

Instantiate a new TxInput

Trait Implementations

impl<M> ByteFormat for TxInput<M> where
    M: MarkedDigestOutput + ByteFormat, 

type Error = SerError

An associated error type

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

fn read_from<T>(reader: &mut T) -> SerResult<Self> where
    T: Read,
    Self: Sized, 

Deserializes an instance of Self from a std::io::Read. The limit argument is used only when deserializing collections, and specifies a maximum number of instances of the underlying type to read.

fn write_to<T>(&self, writer: &mut T) -> SerResult<usize> where
    T: Write, 

Serializes self to a std::io::Write. Following Write trait conventions, its Ok type must be a usize denoting the number of bytes written.

fn read_seq_from<R>(
    reader: &mut R,
    mode: ReadSeqMode
) -> Result<Vec<Self, Global>, Self::Error> where
    R: Read, 

Read a sequence of exactly limit objects from the reader.

fn write_seq_to<'a, W, E, Iter, Item>(
    writer: &mut W,
    iter: Iter
) -> Result<usize, Self::Error> where
    Item: 'a + ByteFormat<Error = E>,
    W: Write,
    Iter: IntoIterator<Item = &'a Item>,
    E: Into<Self::Error> + From<SerError> + From<Error> + Error, 

Write a sequence of ByteFormat objects to a writer. The iter argument may be any object that implements IntoIterator<Item = &Item>. This means we can seamlessly use vectors, slices, etc.

fn deserialize_hex(s: &str) -> Result<Self, Self::Error>

Decodes a hex string to a Vec<u8>, deserializes an instance of Self from that vector.

fn deserialize_base64(s: &str) -> Result<Self, Self::Error>

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

fn serialize_hex(&self) -> String

Serializes self to a vector, returns the hex-encoded vector

fn serialize_base64(&self) -> String

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

impl<M: Clone> Clone for TxInput<M> where
    M: MarkedDigestOutput, 

fn clone(&self) -> TxInput<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for TxInput<M> where
    M: MarkedDigestOutput, 

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

Formats the value using the given formatter.

impl<M> Default for TxInput<M> where
    M: MarkedDigestOutput, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, M> Deserialize<'de> for TxInput<M> where
    M: MarkedDigestOutput,
    M: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<M> Input for TxInput<M> where
    M: MarkedDigestOutput, 

type TxoIdentifier = Outpoint<M>

An input must define what type contains the TXO ID it is spending.

impl<M: PartialEq> PartialEq<TxInput<M>> for TxInput<M> where
    M: MarkedDigestOutput, 

fn eq(&self, other: &TxInput<M>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TxInput<M>) -> bool

This method tests for !=.

impl<M> Serialize for TxInput<M> where
    M: MarkedDigestOutput,
    M: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<M: Eq> Eq for TxInput<M> where
    M: MarkedDigestOutput, 

impl<M> StructuralEq for TxInput<M> where
    M: MarkedDigestOutput, 

impl<M> StructuralPartialEq for TxInput<M> where
    M: MarkedDigestOutput,