Merge pull request #86 from dingxiangfei2009/fix-multi-line-indent

Properly indent multiline messages

Author: oli-obk

examples/basic.rs

@@ -2,6 +2,12 @@ use tracing::{debug, error, info, instrument, span, warn, Level};
 use tracing_subscriber::{layer::SubscriberExt, registry::Registry};
 use tracing_tree::HierarchicalLayer;
 
+#[derive(Debug)]
+struct PrettyPrintMe {
+    value_a: u32,
+    value_b: String,
+}
+
 fn main() {
     let layer = HierarchicalLayer::default()
         .with_writer(std::io::stdout)
@@ -50,6 +56,18 @@ fn main() {
         error!("hello");
     });
     drop(peer3);
+    let val = format!(
+        "{:#?}",
+        PrettyPrintMe {
+            value_a: 42,
+            value_b: "hello".into(),
+        }
+    );
+    let peer3 = span!(Level::TRACE, "", val = %val);
+    peer3.in_scope(|| {
+        error!("hello");
+    });
+    drop(peer3);
     let peer1 = span!(Level::TRACE, "conn", peer_addr = "82.9.9.9", port = 42381);
     peer1.in_scope(|| {
         warn!(algo = "xor", "weak encryption requested");

examples/basic.stdout

@@ -20,6 +20,17 @@
 1:main   ┌┘basic::foomp 42 <- format string, normal_var=43
 1:main  ┌┘basic::server host="localhost", port=8080
 1:main  └┐basic::server host="localhost", port=8080
+1:main   └┐basic:: val=PrettyPrintMe {
+1:main    │      value_a: 42,
+1:main    │      value_b: "hello",
+1:main    │  }
+1:main    ├─ ERROR basic hello
+1:main   ┌┘basic:: val=PrettyPrintMe {
+1:main   │      value_a: 42,
+1:main   │      value_b: "hello",
+1:main   │  }
+1:main  ┌┘basic::server host="localhost", port=8080
+1:main  └┐basic::server host="localhost", port=8080
 1:main   └┐basic::conn peer_addr="82.9.9.9", port=42381
 1:main    ├─ WARN basic weak encryption requested, algo="xor"
 1:main    ├─ DEBUG basic response sent, length=8

examples/no-indent.rs

@@ -2,6 +2,12 @@ use tracing::{debug, error, info, instrument, span, warn, Level};
 use tracing_subscriber::{layer::SubscriberExt, registry::Registry};
 use tracing_tree::HierarchicalLayer;
 
+#[derive(Debug)]
+struct PrettyPrintMe {
+    value_a: u32,
+    value_b: String,
+}
+
 fn main() {
     let layer = HierarchicalLayer::default()
         .with_writer(std::io::stdout)
@@ -47,6 +53,18 @@ fn main() {
         error!("hello");
     });
     drop(peer3);
+    let val = format!(
+        "{:#?}",
+        PrettyPrintMe {
+            value_a: 42,
+            value_b: "hello".into(),
+        }
+    );
+    let peer3 = span!(Level::TRACE, "", val = %val);
+    peer3.in_scope(|| {
+        error!("hello");
+    });
+    drop(peer3);
     let peer1 = span!(Level::TRACE, "conn", peer_addr = "82.9.9.9", port = 42381);
     peer1.in_scope(|| {
         warn!(algo = "xor", "weak encryption requested");

examples/no-indent.stdout

@@ -9,6 +9,11 @@
 1:main      DEBUG no_indent connected
 1:main     no_indent::foomp 42 <- format string, normal_var=43
 1:main      ERROR no_indent hello
+1:main     no_indent:: val=PrettyPrintMe {
+1:main           value_a: 42,
+1:main           value_b: "hello",
+1:main       }
+1:main      ERROR no_indent hello
 1:main     no_indent::conn peer_addr="82.9.9.9", port=42381
 1:main      WARN no_indent weak encryption requested, algo="xor"
 1:main      DEBUG no_indent response sent, length=8

src/format.rs

@@ -448,12 +448,14 @@ fn indent_block_with_lines(
 
     // add the rest of the indentation, since we don't want to draw horizontal lines
     // for subsequent lines
-    for i in 0..indent_amount {
-        if i % indent_amount == 0 {
-            s.push_str(LINE_VERT);
-        } else {
-            s.push(' ');
-        }
+    match style {
+        SpanMode::Open { .. } | SpanMode::Retrace { .. } => s.push_str("  "),
+        SpanMode::Close { .. } => s.push(' '),
+        _ => {}
+    }
+    s.push_str(LINE_VERT);
+    for _ in 1..=indent_amount {
+        s.push(' ');
     }
 
     // add all of the actual content, with each line preceded by the indent string
@@ -489,11 +491,16 @@ fn indent_block(
     if indent_lines {
         indent_block_with_lines(&lines, buf, indent, indent_amount, prefix, style);
     } else {
-        let indent_str = String::from(" ").repeat(indent_spaces);
+        let mut indent_str = " ".repeat(indent_spaces);
+        let mut first_line = true;
         for line in lines {
             buf.push_str(prefix);
             buf.push(' ');
             buf.push_str(&indent_str);
+            if first_line {
+                first_line = false;
+                indent_str.push_str("  ");
+            }
             buf.push_str(line);
             buf.push('\n');
         }