Struct OutPoint

pub struct OutPoint {
    pub txid: Txid,
    pub index: u16,
}

A reference to a transaction output.

Differs from bitcoin::transaction::OutPoint as the index is a u16 instead of u32 due to LN’s restrictions on index values. Should reduce (possibly) unsafe conversions this way.

Fields

txid: Txid

The referenced transaction’s txid.

index: u16

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

Implementations

impl OutPoint

pub fn into_bitcoin_outpoint(self) -> OutPoint

Converts this OutPoint into the OutPoint field as used by rust-bitcoin

This is not exported to bindings users as the same type is used universally in the C bindings for all outpoints

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

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

Formats the value using the given formatter.

impl From<OutPoint> for MonitorName

fn from(value: OutPoint) -> MonitorName

Creates a MonitorName from an OutPoint.

This is typically used when you need to generate a storage key or identifier for a new or existing channel monitor.

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

fn read<R>(r: &mut R) -> Result<OutPoint, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl TryFrom<&MonitorName> for OutPoint

fn try_from(value: &MonitorName) -> Result<OutPoint, Error>

Attempts to convert a MonitorName back into an OutPoint.

This is useful when you have a MonitorName (perhaps retrieved from storage) and need to reconstruct the original OutPoint it represents.

type Error = Error

The type returned in the event of a conversion error.

impl Writeable for OutPoint

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

where W: Writer,

Writes self out to the given Writer.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

impl Copy for OutPoint

impl Eq for OutPoint

impl StructuralPartialEq for OutPoint