Rename `CandidateRouteHop::FirstHop::node_id` and make it a ref
[rust-lightning] / lightning / src / util / logger.rs
index f1534933792949a41318c3b80e0cc1847cbf63f4..8ca5333f63daabf21a5baed562ec8d0ae2053327 100644 (file)
@@ -98,6 +98,10 @@ pub struct Record<'a> {
        /// The verbosity level of the message.
        pub level: Level,
        /// The node id of the peer pertaining to the logged record.
+       ///
+       /// Note that in some cases a [`Self::channel_id`] may be filled in but this may still be
+       /// `None`, depending on if the peer information is readily available in LDK when the log is
+       /// generated.
        pub peer_id: Option<PublicKey>,
        /// The channel id of the channel pertaining to the logged record. May be a temporary id before
        /// the channel has been funded.