Struct OutPoint

pub struct OutPoint {
    pub txid: Txid,
    pub vout: u32,
}

A reference to a transaction output.

Bitcoin Core References

• COutPoint definition

Fields

txid: Txid

The referenced transaction’s txid.

vout: u32

The index of the referenced output in its transaction’s vout.

Implementations

impl OutPoint

pub const fn new(txid: Txid, vout: u32) -> OutPoint

Creates a new OutPoint.

pub fn null() -> OutPoint

Creates a “null” OutPoint.

This value is used for coinbase transactions because they don’t have any previous outputs.

pub fn is_null(&self) -> bool

Checks if an OutPoint is “null”.

Examples

use bitcoin::consensus::params;
use bitcoin::constants::genesis_block;
use bitcoin::Network;

let block = genesis_block(&params::MAINNET);
let tx = &block.txdata[0];

// Coinbase transactions don't have any previous output.
assert!(tx.input[0].previous_output.is_null());

Trait Implementations

impl Clone for OutPoint

fn clone(&self) -> OutPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutPoint

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

Formats the value using the given formatter.

impl Decodable for OutPoint

fn consensus_decode<R>(r: &mut R) -> Result<OutPoint, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

impl Default for OutPoint

fn default() -> OutPoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutPoint

fn deserialize<D>( deserializer: D, ) -> Result<OutPoint, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OutPoint

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

Formats the value using the given formatter.

impl Encodable for OutPoint

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>

where W: Write + ?Sized,

Encodes an object with a well-defined format.

impl FromStr for OutPoint

type Err = ParseOutPointError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<OutPoint, <OutPoint as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for OutPoint

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

where __H: Hasher,

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 Ord for OutPoint

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

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

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for OutPoint

impl Eq for OutPoint

impl StructuralPartialEq for OutPoint