Refactor FmtExtraInfo with FormatterContext

Author: SpriteOvO

spdlog/benches/spdlog-rs/pattern.rs

@@ -8,7 +8,7 @@ use paste::paste;
 #[cfg(feature = "serde_json")]
 use spdlog::formatter::JsonFormatter;
 use spdlog::{
-    formatter::{pattern, Formatter, FullFormatter, Pattern, PatternFormatter},
+    formatter::{pattern, Formatter, FormatterContext, FullFormatter, Pattern, PatternFormatter},
     prelude::*,
     sink::Sink,
     Record, StringBuf,
@@ -22,17 +22,18 @@ include!(concat!(
 ));
 use test_utils::*;
 
-#[derive(Clone)]
 struct BenchSink<F> {
     formatter: F,
     buffer: RefCell<StringBuf>,
+    ctx: RefCell<FormatterContext>,
 }
 
 impl<F: Formatter> BenchSink<F> {
     fn new(formatter: F) -> Self {
         Self {
             formatter,
             buffer: RefCell::new(StringBuf::with_capacity(512)),
+            ctx: RefCell::new(FormatterContext::new()),
         }
     }
 }
@@ -43,8 +44,11 @@ unsafe impl<F> Sync for BenchSink<F> {}
 
 impl<F: Formatter> Sink for BenchSink<F> {
     fn log(&self, record: &Record) -> spdlog::Result<()> {
-        self.formatter
-            .format(record, &mut self.buffer.borrow_mut())?;
+        self.formatter.format(
+            record,
+            &mut self.buffer.borrow_mut(),
+            &mut self.ctx.borrow_mut(),
+        )?;
         Ok(())
     }
 

spdlog/examples/04_format.rs

@@ -34,7 +34,7 @@ fn impl_manually() {
     use std::fmt::Write;
 
     use spdlog::{
-        formatter::{FmtExtraInfo, Formatter},
+        formatter::{Formatter, FormatterContext},
         prelude::*,
         Record, StringBuf,
     };
@@ -43,7 +43,12 @@ fn impl_manually() {
     struct MyFormatter;
 
     impl Formatter for MyFormatter {
-        fn format(&self, record: &Record, dest: &mut StringBuf) -> spdlog::Result<FmtExtraInfo> {
+        fn format(
+            &self,
+            record: &Record,
+            dest: &mut StringBuf,
+            ctx: &mut FormatterContext,
+        ) -> spdlog::Result<()> {
             let style_range_begin = dest.len();
 
             dest.write_str(&record.level().as_str().to_ascii_uppercase())
@@ -53,9 +58,8 @@ fn impl_manually() {
 
             writeln!(dest, " {}", record.payload()).map_err(spdlog::Error::FormatRecord)?;
 
-            Ok(FmtExtraInfo::builder()
-                .style_range(style_range_begin..style_range_end)
-                .build())
+            ctx.set_style_range(Some(style_range_begin..style_range_end));
+            Ok(())
         }
     }
 

spdlog/examples/05_sink.rs

@@ -2,7 +2,7 @@ use std::sync::Arc;
 
 use atomic::{Atomic, Ordering};
 use spdlog::{
-    formatter::{Formatter, FullFormatter},
+    formatter::{Formatter, FormatterContext, FullFormatter},
     prelude::*,
     sink::Sink,
     ErrorHandler, Record, StringBuf,
@@ -34,7 +34,10 @@ impl CollectVecSink {
 impl Sink for CollectVecSink {
     fn log(&self, record: &Record) -> spdlog::Result<()> {
         let mut string_buf = StringBuf::new();
-        self.formatter.read().format(record, &mut string_buf)?;
+        let mut ctx = FormatterContext::new();
+        self.formatter
+            .read()
+            .format(record, &mut string_buf, &mut ctx)?;
         self.collected.lock().push(string_buf.to_string());
         Ok(())
     }

spdlog/src/formatter/full_formatter.rs

@@ -5,7 +5,7 @@ use std::fmt::{self, Write};
 use cfg_if::cfg_if;
 
 use crate::{
-    formatter::{FmtExtraInfo, Formatter, LOCAL_TIME_CACHER},
+    formatter::{Formatter, FormatterContext, LOCAL_TIME_CACHER},
     Error, Record, StringBuf, __EOL,
 };
 
@@ -54,7 +54,8 @@ impl FullFormatter {
         &self,
         record: &Record,
         dest: &mut StringBuf,
-    ) -> Result<FmtExtraInfo, fmt::Error> {
+        ctx: &mut FormatterContext,
+    ) -> Result<(), fmt::Error> {
         cfg_if! {
             if #[cfg(not(feature = "flexible-string"))] {
                 dest.reserve(crate::string_buf::RESERVE_SIZE);
@@ -98,15 +99,20 @@ impl FullFormatter {
             dest.write_str(__EOL)?;
         }
 
-        Ok(FmtExtraInfo {
-            style_range: Some(style_range_begin..style_range_end),
-        })
+        ctx.set_style_range(Some(style_range_begin..style_range_end));
+        Ok(())
     }
 }
 
 impl Formatter for FullFormatter {
-    fn format(&self, record: &Record, dest: &mut StringBuf) -> crate::Result<FmtExtraInfo> {
-        self.format_impl(record, dest).map_err(Error::FormatRecord)
+    fn format(
+        &self,
+        record: &Record,
+        dest: &mut StringBuf,
+        ctx: &mut FormatterContext,
+    ) -> crate::Result<()> {
+        self.format_impl(record, dest, ctx)
+            .map_err(Error::FormatRecord)
     }
 }
 
@@ -127,7 +133,10 @@ mod tests {
     fn format() {
         let record = Record::new(Level::Warn, "test log content");
         let mut buf = StringBuf::new();
-        let extra_info = FullFormatter::new().format(&record, &mut buf).unwrap();
+        let mut ctx = FormatterContext::new();
+        FullFormatter::new()
+            .format(&record, &mut buf, &mut ctx)
+            .unwrap();
 
         let local_time: DateTime<Local> = record.time().into();
         assert_eq!(
@@ -138,6 +147,6 @@ mod tests {
             ),
             buf
         );
-        assert_eq!(Some(27..31), extra_info.style_range());
+        assert_eq!(Some(27..31), ctx.style_range());
     }
 }

spdlog/src/formatter/journald_formatter.rs

@@ -8,7 +8,7 @@ use std::fmt::{self, Write};
 use cfg_if::cfg_if;
 
 use crate::{
-    formatter::{FmtExtraInfo, Formatter},
+    formatter::{Formatter, FormatterContext},
     Error, Record, StringBuf, __EOL,
 };
 
@@ -25,7 +25,8 @@ impl JournaldFormatter {
         &self,
         record: &Record,
         dest: &mut StringBuf,
-    ) -> Result<FmtExtraInfo, fmt::Error> {
+        ctx: &mut FormatterContext,
+    ) -> Result<(), fmt::Error> {
         cfg_if! {
             if #[cfg(not(feature = "flexible-string"))] {
                 dest.reserve(crate::string_buf::RESERVE_SIZE);
@@ -49,15 +50,20 @@ impl JournaldFormatter {
         dest.write_str(record.payload())?;
         dest.write_str(__EOL)?;
 
-        Ok(FmtExtraInfo {
-            style_range: Some(style_range_begin..style_range_end),
-        })
+        ctx.set_style_range(Some(style_range_begin..style_range_end));
+        Ok(())
     }
 }
 
 impl Formatter for JournaldFormatter {
-    fn format(&self, record: &Record, dest: &mut StringBuf) -> crate::Result<FmtExtraInfo> {
-        self.format_impl(record, dest).map_err(Error::FormatRecord)
+    fn format(
+        &self,
+        record: &Record,
+        dest: &mut StringBuf,
+        ctx: &mut FormatterContext,
+    ) -> crate::Result<()> {
+        self.format_impl(record, dest, ctx)
+            .map_err(Error::FormatRecord)
     }
 }
 

spdlog/src/formatter/json_formatter.rs

@@ -8,7 +8,7 @@ use cfg_if::cfg_if;
 use serde::{ser::SerializeStruct, Serialize};
 
 use crate::{
-    formatter::{FmtExtraInfo, Formatter},
+    formatter::{Formatter, FormatterContext},
     Error, Record, StringBuf, __EOL,
 };
 
@@ -146,7 +146,8 @@ impl JsonFormatter {
         &self,
         record: &Record,
         dest: &mut StringBuf,
-    ) -> Result<FmtExtraInfo, JsonFormatterError> {
+        _ctx: &mut FormatterContext,
+    ) -> Result<(), JsonFormatterError> {
         cfg_if! {
             if #[cfg(not(feature = "flexible-string"))] {
                 dest.reserve(crate::string_buf::RESERVE_SIZE);
@@ -163,13 +164,18 @@ impl JsonFormatter {
 
         dest.write_str(__EOL)?;
 
-        Ok(FmtExtraInfo { style_range: None })
+        Ok(())
     }
 }
 
 impl Formatter for JsonFormatter {
-    fn format(&self, record: &Record, dest: &mut StringBuf) -> crate::Result<FmtExtraInfo> {
-        self.format_impl(record, dest).map_err(Into::into)
+    fn format(
+        &self,
+        record: &Record,
+        dest: &mut StringBuf,
+        ctx: &mut FormatterContext,
+    ) -> crate::Result<()> {
+        self.format_impl(record, dest, ctx).map_err(Into::into)
     }
 }
 
@@ -191,11 +197,12 @@ mod tests {
         let mut dest = StringBuf::new();
         let formatter = JsonFormatter::new();
         let record = Record::builder(Level::Info, "payload").build();
-        let extra_info = formatter.format(&record, &mut dest).unwrap();
+        let mut ctx = FormatterContext::new();
+        formatter.format(&record, &mut dest, &mut ctx).unwrap();
 
         let local_time: DateTime<Local> = record.time().into();
 
-        assert_eq!(extra_info.style_range, None);
+        assert_eq!(ctx.style_range(), None);
         assert_eq!(
             dest.to_string(),
             format!(
@@ -215,11 +222,12 @@ mod tests {
         let record = Record::builder(Level::Info, "payload")
             .logger_name("my-component")
             .build();
-        let extra_info = formatter.format(&record, &mut dest).unwrap();
+        let mut ctx = FormatterContext::new();
+        formatter.format(&record, &mut dest, &mut ctx).unwrap();
 
         let local_time: DateTime<Local> = record.time().into();
 
-        assert_eq!(extra_info.style_range, None);
+        assert_eq!(ctx.style_range(), None);
         assert_eq!(
             dest.to_string(),
             format!(
@@ -239,11 +247,12 @@ mod tests {
         let record = Record::builder(Level::Info, "payload")
             .source_location(Some(SourceLocation::__new("module", "file.rs", 1, 2)))
             .build();
-        let extra_info = formatter.format(&record, &mut dest).unwrap();
+        let mut ctx = FormatterContext::new();
+        formatter.format(&record, &mut dest, &mut ctx).unwrap();
 
         let local_time: DateTime<Local> = record.time().into();
 
-        assert_eq!(extra_info.style_range, None);
+        assert_eq!(ctx.style_range(), None);
         assert_eq!(
             dest.to_string(),
             format!(

spdlog/src/formatter/mod.rs

@@ -84,27 +84,33 @@ use crate::{Record, Result, StringBuf};
 /// [./examples]: https://github.com/SpriteOvO/spdlog-rs/tree/main/spdlog/examples
 pub trait Formatter: Send + Sync + DynClone {
     /// Formats a log record.
-    fn format(&self, record: &Record, dest: &mut StringBuf) -> Result<FmtExtraInfo>;
+    fn format(
+        &self,
+        record: &Record,
+        dest: &mut StringBuf,
+        ctx: &mut FormatterContext,
+    ) -> Result<()>;
 }
 clone_trait_object!(Formatter);
 
-/// Extra information for formatted text.
-#[derive(Clone, Eq, PartialEq, Hash, Debug, Default)]
-pub struct FmtExtraInfo {
+/// Provides context for formatters.
+#[derive(Debug, Default)]
+pub struct FormatterContext {
     style_range: Option<Range<usize>>,
 }
 
-impl FmtExtraInfo {
-    /// Constructs a `FmtExtraInfo`.
+impl FormatterContext {
+    /// Constructs a `FormatterContext`.
     #[must_use]
-    pub fn new() -> FmtExtraInfo {
-        FmtExtraInfo::default()
+    pub fn new() -> Self {
+        Self { style_range: None }
     }
 
-    /// Gets a [`FmtExtraInfoBuilder`].
-    #[must_use]
-    pub fn builder() -> FmtExtraInfoBuilder {
-        FmtExtraInfoBuilder::new()
+    /// Sets style range (in bytes) of the formatted text.
+    ///
+    /// Users must ensure that indexes are correctly UTF-8 boundary.
+    pub fn set_style_range(&mut self, range: Option<Range<usize>>) {
+        self.style_range = range;
     }
 
     /// A style range (in bytes) of the formatted text.
@@ -120,35 +126,3 @@ impl FmtExtraInfo {
         self.style_range.clone() // This clone is cheap
     }
 }
-
-#[allow(missing_docs)]
-#[derive(Clone, Eq, PartialEq, Hash, Debug, Default)]
-pub struct FmtExtraInfoBuilder {
-    info: FmtExtraInfo,
-}
-
-impl FmtExtraInfoBuilder {
-    /// Constructs a `FmtExtraInfoBuilder`.
-    ///
-    /// The default value of [`FmtExtraInfo`] is the same as
-    /// [`FmtExtraInfo::new`].
-    #[must_use]
-    pub fn new() -> Self {
-        Self::default()
-    }
-
-    /// Sets style range (in bytes) of the formatted text.
-    ///
-    /// Users must ensure that indexes are correctly UTF-8 boundary.
-    #[must_use]
-    pub fn style_range(mut self, range: Range<usize>) -> Self {
-        self.info.style_range = Some(range);
-        self
-    }
-
-    /// Builds a [`FmtExtraInfo`].
-    #[must_use]
-    pub fn build(self) -> FmtExtraInfo {
-        self.info
-    }
-}