}
impl ChannelInfo {
- /// Returns a [`DirectedChannelInfo`] for the channel directed to the given `target`, or `None`
- /// if `target` is not one of the channel's counterparties.
- pub fn as_directed_to(&self, target: &NodeId) -> Option<DirectedChannelInfo> {
- let (direction, source, target) = {
+ /// 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_to(&self, target: &NodeId) -> Option<(DirectedChannelInfo, &NodeId)> {
+ let (direction, source) = {
if target == &self.node_one {
- (self.two_to_one.as_ref(), &self.node_two, &self.node_one)
+ (self.two_to_one.as_ref(), &self.node_two)
} else if target == &self.node_two {
- (self.one_to_two.as_ref(), &self.node_one, &self.node_two)
+ (self.one_to_two.as_ref(), &self.node_one)
} else {
return None;
}
};
- Some(DirectedChannelInfo { channel: self, direction, source, target })
+ Some((DirectedChannelInfo { channel: self, direction }, source))
}
}
/// A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
/// source node to a target node.
-#[derive(Clone, Debug)]
-pub struct DirectedChannelInfo<'a: 'b, 'b> {
+#[derive(Clone)]
+pub struct DirectedChannelInfo<'a> {
channel: &'a ChannelInfo,
- direction: Option<&'b ChannelUpdateInfo>,
- source: &'b NodeId,
- target: &'b NodeId,
+ direction: Option<&'a ChannelUpdateInfo>,
}
-impl<'a: 'b, 'b> DirectedChannelInfo<'a, 'b> {
+impl<'a> DirectedChannelInfo<'a> {
/// Returns information for the channel.
pub fn channel(&self) -> &'a ChannelInfo { self.channel }
/// Returns information for the direction.
- pub fn direction(&self) -> Option<&'b ChannelUpdateInfo> { self.direction }
+ pub fn direction(&self) -> Option<&'a ChannelUpdateInfo> { self.direction }
- /// Returns the node id for the source.
- pub fn source(&self) -> &'b NodeId { self.source }
-
- /// Returns the node id for the target.
- pub fn target(&self) -> &'b NodeId { self.target }
-
- /// Returns the [`EffectiveCapacity`] of the channel in a specific direction.
+ /// 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,
EffectiveCapacity::Total { capacity_msat }))
.unwrap_or(EffectiveCapacity::Unknown)
}
+
+ /// Returns `Some` if [`ChannelUpdateInfo`] is available in the direction.
+ pub(super) fn with_update(self) -> Option<DirectedChannelInfoWithUpdate<'a>> {
+ match self.direction {
+ Some(_) => Some(DirectedChannelInfoWithUpdate { inner: self }),
+ None => None,
+ }
+ }
+}
+
+impl<'a> fmt::Debug for DirectedChannelInfo<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+ f.debug_struct("DirectedChannelInfo")
+ .field("channel", &self.channel)
+ .finish()
+ }
+}
+
+/// A [`DirectedChannelInfo`] with [`ChannelUpdateInfo`] available in its the direction.
+#[derive(Clone)]
+pub(super) struct DirectedChannelInfoWithUpdate<'a> {
+ inner: DirectedChannelInfo<'a>,
+}
+
+impl<'a> DirectedChannelInfoWithUpdate<'a> {
+ /// Returns information for the channel.
+ #[inline]
+ pub(super) fn channel(&self) -> &'a ChannelInfo { &self.inner.channel }
+
+ /// Returns information for the direction.
+ #[inline]
+ pub(super) fn direction(&self) -> &'a ChannelUpdateInfo { self.inner.direction.unwrap() }
+
+ /// Returns the [`EffectiveCapacity`] of the channel in the direction.
+ #[inline]
+ pub(super) fn effective_capacity(&self) -> EffectiveCapacity { self.inner.effective_capacity() }
+}
+
+impl<'a> fmt::Debug for DirectedChannelInfoWithUpdate<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+ self.inner.fmt(f)
+ }
}
/// The effective capacity of a channel for routing purposes.
capacity_msat: u64,
},
/// A capacity sufficient to route any payment, typically used for private channels provided by
- /// an invoice, though may not be the case for zero-amount invoices.
+ /// an invoice.
Infinite,
/// A capacity that is unknown possibly because either the chain state is unavailable to know
/// the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.