Struct bitcoins::types::txout::TxOut

pub struct TxOut {
    pub value: u64,
    pub script_pubkey: ScriptPubkey,
}

An Output. This describes a new UTXO to be created. The value is encoded as an LE u64. The script pubkey encodes the spending constraints.

TxOut::null() and TxOut::default() return the “null” TxOut, which has a value of 0xffff_ffff_ffff_ffff, and an empty script_pubkey. This null output is used within legacy sighash calculations.

Fields

value: u64

The value of the output in satoshis

script_pubkey: ScriptPubkey

The ScriptPubkey which locks the UTXO.

Implementations

impl TxOut

pub fn new<T>(value: u64, script_pubkey: T) -> Self where
    T: Into<ScriptPubkey>, 

Instantiate a new TxOut.

pub fn null() -> Self

Instantiate the null TxOut, which is used in Legacy Sighash.

pub fn op_return(data: &[u8]) -> Self

Instantiate an OP_RETURN output with some data. Discards all but the first 75 bytes.

pub fn standard_type(&self) -> ScriptType

Inspect the TxOut’s script pubkey to determine its type.

pub fn extract_op_return_data(&self) -> Option<Vec<u8>>

Extract the op return payload. None if not an op return.

Trait Implementations

impl ByteFormat for TxOut

type Error = SerError

An associated error type

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

fn read_from<R>(reader: &mut R) -> SerResult<Self> where
    R: 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<W>(&self, writer: &mut W) -> SerResult<usize> where
    W: 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
    W: Write,
    E: Into<Self::Error> + From<SerError> + From<Error> + Error,
    Item: 'a + ByteFormat<Error = E>,
    Iter: IntoIterator<Item = &'a Item>, 

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 Clone for TxOut

fn clone(&self) -> TxOut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TxOut

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

Formats the value using the given formatter.

impl Default for TxOut

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TxOut

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

Deserialize this value from the given Serde deserializer.

impl Output for TxOut

type Value = u64

How is value represented in this Output? For Bitcoin this is a u64.

type RecipientIdentifier = ScriptPubkey

The associated RecipientIdentifier type that describes to whom the output is paid. For Bitcoin, this is a ScriptPubkey

impl PartialEq<TxOut> for TxOut

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

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

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

This method tests for !=.

impl Serialize for TxOut

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

Serialize this value into the given Serde serializer.

impl Eq for TxOut

impl StructuralEq for TxOut

impl StructuralPartialEq for TxOut