Struct bitcoin::blockdata::transaction::OutPoint

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

A reference to a transaction output

Fields

txid: Txid

The referenced transaction's txid

vout: u32

The index of the referenced output in its transaction's vout

Methods

impl OutPoint

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

Create 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::blockdata::constants::genesis_block;
use bitcoin::network::constants::Network;

let block = genesis_block(Network::Bitcoin);
let tx = &block.txdata[0];

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

Trait Implementations

impl Encodable for OutPoint

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl Decodable for OutPoint

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<OutPoint> 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: &OutPoint) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Default for OutPoint

fn default() -> Self

Returns the "default value" for a type.

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

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

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

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

This method tests for !=.

impl Eq for OutPoint

impl Copy for OutPoint

impl Display for OutPoint

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

Formats the value using the given formatter.

impl Debug for OutPoint

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

Formats the value using the given formatter.

impl Hash for OutPoint

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for OutPoint

type Err = ParseOutPointError

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.