Struct Route

pub struct Route {
    pub paths: Vec<Path>,
    pub route_params: Option<RouteParameters>,
}

A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP, it can take multiple paths. Each path is composed of one or more hops through the network.

Fields

paths: Vec<Path>

The list of Paths taken for a single (potentially-)multi-part payment. If no BlindedTails are present, then the pubkey of the last RouteHop in each path must be the same.

route_params: Option<RouteParameters>

The route_params parameter passed to find_route.

This is used by ChannelManager to track information which may be required for retries.

Will be None for objects serialized with LDK versions prior to 0.0.117.

Implementations

impl Route

pub fn get_total_fees(&self) -> u64

Returns the total amount of fees paid on this Route.

For objects serialized with LDK 0.0.117 and after, this includes any extra payment made to the recipient, which can happen in excess of the amount passed to find_route via RouteParameters::final_value_msat, if we had to reach the htlc_minimum_msat limits.

pub fn get_total_amount(&self) -> u64

Returns the total amount paid on this Route, excluding the fees.

Might be more than requested as part of the given RouteParameters::final_value_msat if we had to reach the htlc_minimum_msat limits.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Display for Route

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

Formats the value using the given formatter.

impl Hash for Route

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 Route

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

fn read<R>(reader: &mut R) -> Result<Route, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Writeable for Route

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

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

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.

impl Eq for Route

impl StructuralPartialEq for Route