Struct ChannelInfo

#[repr(C, align(128))]
pub struct ChannelInfo {
    pub features: ChannelFeatures,
    pub node_one: NodeId,
    pub node_two: NodeId,
    pub capacity_sats: Option<u64>,
    pub one_to_two: Option<ChannelUpdateInfo>,
    pub two_to_one: Option<ChannelUpdateInfo>,
    pub announcement_message: Option<ChannelAnnouncement>,
    /* private fields */
}

Details about a channel (both directions). Received within a channel announcement.

Fields

features: ChannelFeatures

Protocol features of a channel communicated during its announcement

node_one: NodeId

Source node of the first direction of a channel

node_two: NodeId

Source node of the second direction of a channel

capacity_sats: Option<u64>

The channel capacity as seen on-chain, if chain lookup is available.

one_to_two: Option<ChannelUpdateInfo>

Details about the first direction of a channel

two_to_one: Option<ChannelUpdateInfo>

Details about the second direction of a channel

announcement_message: Option<ChannelAnnouncement>

An initial announcement of the channel Mostly redundant with the data we store in fields explicitly. Everything else is useful only for sending out for initial routing sync. Not stored if contains excess data to prevent DoS.

Implementations

impl ChannelInfo

pub fn as_directed_to( &self, target: &NodeId, ) -> Option<(DirectedChannelInfo<'_>, &NodeId)>

Returns a DirectedChannelInfo for the channel directed to the given target from a returned source, or None if target is not one of the channel’s counterparties.

pub fn as_directed_from( &self, source: &NodeId, ) -> Option<(DirectedChannelInfo<'_>, &NodeId)>

Returns a DirectedChannelInfo for the channel directed from the given source to a returned target, or None if source is not one of the channel’s counterparties.

pub fn get_directional_info( &self, channel_flags: u8, ) -> Option<&ChannelUpdateInfo>

Returns a ChannelUpdateInfo based on the direction implied by the channel_flag.

Trait Implementations

impl Clone for ChannelInfo

fn clone(&self) -> ChannelInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelInfo

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

Formats the value using the given formatter.

impl Display for ChannelInfo

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

Formats the value using the given formatter.

impl PartialEq for ChannelInfo

fn eq(&self, o: &ChannelInfo) -> 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 ChannelInfo

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

Reads a Self in from the given Read.

impl Writeable for ChannelInfo

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

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 ChannelInfo