Merge pull request #2110 from munjesi/docs_fixes

[rust-lightning] / lightning / src / util / logger.rs

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index ff576e26ddf4ca485d648c943ad3f36384b30653..aac83f42a3c2f82a5520fc380f4006ca345288e2 100644 (file)
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -14,11 +14,13 @@
 //! The second one, client-side by implementing check against Record Level field.
 //! Each module may have its own Logger or share one.
 
+use bitcoin::secp256k1::PublicKey;
+
 use core::cmp;
 use core::fmt;
 
 #[cfg(c_bindings)]
-use prelude::*; // Needed for String
+use crate::prelude::*; // Needed for String
 
 static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
 
@@ -114,7 +116,8 @@ pub struct Record<'a> {
 
 impl<'a> Record<'a> {
        /// Returns a new Record.
-       /// (C-not exported) as fmt can't be used in C
+       ///
+       /// This is not exported to bindings users as fmt can't be used in C
        #[inline]
        pub fn new(level: Level, args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32) -> Record<'a> {
                Record {
@@ -138,8 +141,23 @@ pub trait Logger {
        fn log(&self, record: &Record);
 }
 
+/// Wrapper for logging a [`PublicKey`] in hex format.
+///
+/// This is not exported to bindings users as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugPubKey<'a>(pub &'a PublicKey);
+impl<'a> core::fmt::Display for DebugPubKey<'a> {
+       fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+               for i in self.0.serialize().iter() {
+                       write!(f, "{:02x}", i)?;
+               }
+               Ok(())
+       }
+}
+
 /// Wrapper for logging byte slices in hex format.
-/// (C-not exported) as fmt can't be used in C
+///
+/// This is not exported to bindings users as fmt can't be used in C
 #[doc(hidden)]
 pub struct DebugBytes<'a>(pub &'a [u8]);
 impl<'a> core::fmt::Display for DebugBytes<'a> {
@@ -153,9 +171,9 @@ impl<'a> core::fmt::Display for DebugBytes<'a> {
 
 #[cfg(test)]
 mod tests {
-       use util::logger::{Logger, Level};
-       use util::test_utils::TestLogger;
-       use sync::Arc;
+       use crate::util::logger::{Logger, Level};
+       use crate::util::test_utils::TestLogger;
+       use crate::sync::Arc;
 
        #[test]
        fn test_level_show() {