Merge pull request #2434 from TheBlueMatt/2023-07-116-bindings-part-2

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

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index 154e26cdf454bb8d4ff513156c5e4efee7b544a1..dbca9b785e85dfbaf3c68253e7e47b91225c6bdc 100644 (file)
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -116,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 {
@@ -141,7 +142,8 @@ pub trait Logger {
 }
 
 /// Wrapper for logging a [`PublicKey`] 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 DebugPubKey<'a>(pub &'a PublicKey);
 impl<'a> core::fmt::Display for DebugPubKey<'a> {
@@ -154,7 +156,8 @@ impl<'a> core::fmt::Display for DebugPubKey<'a> {
 }
 
 /// 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> {
@@ -166,6 +169,26 @@ impl<'a> core::fmt::Display for DebugBytes<'a> {
        }
 }
 
+/// Wrapper for logging `Iterator`s.
+///
+/// This is not exported to bindings users as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugIter<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone>(pub I);
+impl<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone> fmt::Display for DebugIter<T, I> {
+       fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+               write!(f, "[")?;
+               let mut iter = self.0.clone();
+               if let Some(item) = iter.next() {
+                       write!(f, "{}", item)?;
+               }
+               while let Some(item) = iter.next() {
+                       write!(f, ", {}", item)?;
+               }
+               write!(f, "]")?;
+               Ok(())
+       }
+}
+
 #[cfg(test)]
 mod tests {
        use crate::util::logger::{Logger, Level};