Struct DirectedChannelInfo

pub struct DirectedChannelInfo<'a> { /* private fields */ }

A wrapper around ChannelInfo representing information about the channel as directed from a source node to a target node.

Implementations

impl<'a> DirectedChannelInfo<'a>

pub fn channel(&self) -> &'a ChannelInfo

Returns information for the channel.

pub fn effective_capacity(&self) -> EffectiveCapacity

Returns the EffectiveCapacity of the channel in the direction.

This is either the total capacity from the funding transaction, if known, or the htlc_maximum_msat for the direction as advertised by the gossip network, if known, otherwise.

pub fn source(&self) -> &'a NodeId

Returns the node_id of the source hop.

Refers to the node_id forwarding the payment to the next hop.

pub fn target(&self) -> &'a NodeId

Returns the node_id of the target hop.

Refers to the node_id receiving the payment from the previous hop.

Trait Implementations

impl<'a> Clone for DirectedChannelInfo<'a>

fn clone(&self) -> DirectedChannelInfo<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DirectedChannelInfo<'a>

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

Formats the value using the given formatter.