Merge pull request #2162 from jkczyz/2023-04-invoice-hash

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

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index 103f89891cf30115c238f0a9494379c8e6719169..aac83f42a3c2f82a5520fc380f4006ca345288e2 100644 (file)
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -14,9 +14,14 @@
 //! 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 crate::prelude::*; // Needed for String
+
 static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
 
 /// An enum representing the available verbosity levels of the logger.
@@ -86,32 +91,46 @@ impl Level {
 
 /// A Record, unit of logging output with Metadata to enable filtering
 /// Module_path, file, line to inform on log's source
-/// (C-not exported) - we convert to a const char* instead
-#[derive(Clone,Debug)]
+#[derive(Clone, Debug)]
 pub struct Record<'a> {
        /// The verbosity level of the message.
        pub level: Level,
+       #[cfg(not(c_bindings))]
        /// The message body.
        pub args: fmt::Arguments<'a>,
+       #[cfg(c_bindings)]
+       /// The message body.
+       pub args: String,
        /// The module path of the message.
-       pub module_path: &'a str,
+       pub module_path: &'static str,
        /// The source file containing the message.
-       pub file: &'a str,
+       pub file: &'static str,
        /// The line containing the message.
        pub line: u32,
+
+       #[cfg(c_bindings)]
+       /// We don't actually use the lifetime parameter in C bindings (as there is no good way to
+       /// communicate a lifetime to a C, or worse, Java user).
+       _phantom: core::marker::PhantomData<&'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: &'a str, file: &'a str, line: u32) -> Record<'a> {
+       pub fn new(level: Level, args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32) -> Record<'a> {
                Record {
                        level,
+                       #[cfg(not(c_bindings))]
                        args,
+                       #[cfg(c_bindings)]
+                       args: format!("{}", args),
                        module_path,
                        file,
-                       line
+                       line,
+                       #[cfg(c_bindings)]
+                       _phantom: core::marker::PhantomData,
                }
        }
 }
@@ -122,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> {
@@ -137,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() {