pub struct ChannelInfo {
pub features: ChannelFeatures,
pub node_one: NodeId,
pub one_to_two: Option<ChannelUpdateInfo>,
pub node_two: NodeId,
pub two_to_one: Option<ChannelUpdateInfo>,
pub capacity_sats: Option<u64>,
pub announcement_message: Option<ChannelAnnouncement>,
/* private fields */
}
Expand description
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
one_to_two: Option<ChannelUpdateInfo>
Details about the first direction of a channel
node_two: NodeId
Source node of the second direction of a channel
two_to_one: Option<ChannelUpdateInfo>
Details about the second direction of a channel
capacity_sats: Option<u64>
The channel capacity as seen on-chain, if chain lookup is available.
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
sourceimpl ChannelInfo
impl ChannelInfo
sourcepub fn as_directed_to(
&self,
target: &NodeId
) -> Option<(DirectedChannelInfo<'_>, &NodeId)>
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.
sourcepub fn as_directed_from(
&self,
source: &NodeId
) -> Option<(DirectedChannelInfo<'_>, &NodeId)>
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.
sourcepub fn get_directional_info(
&self,
channel_flags: u8
) -> Option<&ChannelUpdateInfo>
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
sourceimpl Clone for ChannelInfo
impl Clone for ChannelInfo
sourcefn clone(&self) -> ChannelInfo
fn clone(&self) -> ChannelInfo
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ChannelInfo
impl Debug for ChannelInfo
sourceimpl Display for ChannelInfo
impl Display for ChannelInfo
sourceimpl PartialEq<ChannelInfo> for ChannelInfo
impl PartialEq<ChannelInfo> for ChannelInfo
sourcefn eq(&self, other: &ChannelInfo) -> bool
fn eq(&self, other: &ChannelInfo) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl Readable for ChannelInfo
impl Readable for ChannelInfo
sourceimpl Writeable for ChannelInfo
impl Writeable for ChannelInfo
sourcefn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>
Writes self out to the given Writer
sourcefn encode(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
fn encode(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where
A: Allocator,
A: Allocator,
Writes self out to a Vec
sourcefn serialized_length(&self) -> usize
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. Read more
impl StructuralPartialEq for ChannelInfo
Auto Trait Implementations
impl RefUnwindSafe for ChannelInfo
impl Send for ChannelInfo
impl Sync for ChannelInfo
impl Unpin for ChannelInfo
impl UnwindSafe for ChannelInfo
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more