Struct Path

pub struct Path {
    pub hops: Vec<RouteHop>,
    pub blinded_tail: Option<BlindedTail>,
}

A path in a Route to the payment recipient. Must always be at least length one. If no Path::blinded_tail is present, then Path::hops length may be up to 19.

Fields

hops: Vec<RouteHop>

The list of unblinded hops in this Path. Must be at least length one.

blinded_tail: Option<BlindedTail>

The blinded path at which this path terminates, if we’re sending to one, and its metadata.

Implementations

impl Path

pub fn fee_msat(&self) -> u64

Gets the fees for a given path, excluding any excess paid to the recipient.

pub fn final_value_msat(&self) -> u64

Gets the total amount paid on this Path, excluding the fees.

pub fn final_cltv_expiry_delta(&self) -> Option<u32>

Gets the final hop’s CLTV expiry delta.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Hash for Path

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

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

impl StructuralPartialEq for Path