chore: lazy_entry => deferred_spans

Author: ten3roberts

examples/basic.rs

@@ -10,7 +10,8 @@ fn main() {
         .with_thread_names(true)
         .with_thread_ids(true)
         .with_verbose_exit(true)
-        .with_verbose_entry(true)
+        .with_verbose_entry(false)
+        .with_span_modes(true)
         .with_targets(true);
 
     let subscriber = Registry::default().with(layer);

examples/concurrent.rs

@@ -19,7 +19,7 @@ fn main() {
         .with_verbose_exit(true)
         .with_verbose_entry(true)
         .with_verbose_retrace(true)
-        .with_lazy_entry(true)
+        .with_deferred_spans(true)
         .with_targets(true);
 
     let subscriber = Registry::default().with(layer);

src/format.rs

@@ -57,7 +57,7 @@ pub struct Config {
     /// Whether to print squiggly brackets (`{}`) around the list of fields in a span.
     pub bracketed_fields: bool,
 
-    pub lazy_entry: bool,
+    pub deferred_spans: bool,
 
     pub span_modes: bool,
 }
@@ -117,9 +117,9 @@ impl Config {
         }
     }
 
-    pub fn with_lazy_entry(self, enable: bool) -> Self {
+    pub fn with_deferred_spans(self, enable: bool) -> Self {
         Self {
-            lazy_entry: enable,
+            deferred_spans: enable,
             ..self
         }
     }
@@ -175,7 +175,7 @@ impl Default for Config {
             verbose_exit: false,
             verbose_retrace: false,
             bracketed_fields: false,
-            lazy_entry: false,
+            deferred_spans: false,
             span_modes: false,
         }
     }

src/lib.rs

@@ -211,9 +211,12 @@ where
         }
     }
 
-    pub fn with_lazy_entry(self, enabled: bool) -> Self {
+    /// Defers printing span opening until an event is generated within the span.
+    ///
+    /// Avoids printing empty spans with no generated events.
+    pub fn with_deferred_spans(self, enabled: bool) -> Self {
         Self {
-            config: self.config.with_lazy_entry(enabled),
+            config: self.config.with_deferred_spans(enabled),
             ..self
         }
     }
@@ -353,12 +356,12 @@ where
         let span = ctx.span(id).expect("in new_span but span does not exist");
 
         if span.extensions().get::<Data>().is_none() {
-            let data = Data::new(attrs, !self.config.lazy_entry);
+            let data = Data::new(attrs, !self.config.deferred_spans);
             span.extensions_mut().insert(data);
         }
 
         // Entry will be printed in on_event along with retrace
-        if self.config.lazy_entry {
+        if self.config.deferred_spans {
             return;
         }
 
@@ -541,7 +544,7 @@ where
         let span = ctx.span(&id);
 
         // Span was not printed, so don't print an exit
-        if self.config.lazy_entry
+        if self.config.deferred_spans
             && span
                 .as_ref()
                 .and_then(|v| v.extensions().get::<Data>().map(|v| v.printed))