refactor(fmt): Make DefaultFormats name more specific

Author: epage

src/fmt/mod.rs

@@ -228,7 +228,7 @@ pub(crate) type FormatFn = Box<dyn RecordFormat + Sync + Send>;
 
 #[derive(Default)]
 pub(crate) struct Builder {
-    pub(crate) default_format: DefaultFormat,
+    pub(crate) default_format: ConfigurableFormat,
     pub(crate) custom_format: Option<FormatFn>,
     built: bool,
 }
@@ -290,7 +290,7 @@ type StyledValue<T> = T;
 /// The default format.
 ///
 /// This format needs to work with any combination of crate features.
-pub(crate) struct DefaultFormat {
+pub(crate) struct ConfigurableFormat {
     pub(crate) timestamp: Option<TimestampPrecision>,
     pub(crate) module_path: bool,
     pub(crate) target: bool,
@@ -303,7 +303,7 @@ pub(crate) struct DefaultFormat {
     pub(crate) kv_format: Option<Box<KvFormatFn>>,
 }
 
-impl DefaultFormat {
+impl ConfigurableFormat {
     /// Whether or not to write the level in the default format.
     pub(crate) fn level(&mut self, write: bool) -> &mut Self {
         self.level = write;
@@ -375,7 +375,7 @@ impl DefaultFormat {
     }
 }
 
-impl Default for DefaultFormat {
+impl Default for ConfigurableFormat {
     fn default() -> Self {
         Self {
             timestamp: Some(Default::default()),
@@ -392,9 +392,9 @@ impl Default for DefaultFormat {
     }
 }
 
-impl RecordFormat for DefaultFormat {
+impl RecordFormat for ConfigurableFormat {
     fn format(&self, formatter: &mut Formatter, record: &Record<'_>) -> io::Result<()> {
-        let fmt = DefaultFormatWriter {
+        let fmt = ConfigurableFormatWriter {
             format: self,
             buf: formatter,
             written_header_value: false,
@@ -407,13 +407,13 @@ impl RecordFormat for DefaultFormat {
 /// The default format.
 ///
 /// This format needs to work with any combination of crate features.
-struct DefaultFormatWriter<'a> {
-    format: &'a DefaultFormat,
+struct ConfigurableFormatWriter<'a> {
+    format: &'a ConfigurableFormat,
     buf: &'a mut Formatter,
     written_header_value: bool,
 }
 
-impl DefaultFormatWriter<'_> {
+impl ConfigurableFormatWriter<'_> {
     fn write(mut self, record: &Record<'_>) -> io::Result<()> {
         self.write_timestamp()?;
         self.write_level(record)?;
@@ -567,7 +567,7 @@ impl DefaultFormatWriter<'_> {
                 // Create a wrapper around the buffer only if we have to actually indent the message
 
                 struct IndentWrapper<'a, 'b> {
-                    fmt: &'a mut DefaultFormatWriter<'b>,
+                    fmt: &'a mut ConfigurableFormatWriter<'b>,
                     indent_count: usize,
                 }
 
@@ -627,7 +627,7 @@ mod tests {
 
     use log::{Level, Record};
 
-    fn write_record(record: Record<'_>, fmt: DefaultFormatWriter<'_>) -> String {
+    fn write_record(record: Record<'_>, fmt: ConfigurableFormatWriter<'_>) -> String {
         let buf = fmt.buf.buf.clone();
 
         fmt.write(&record).expect("failed to write record");
@@ -636,7 +636,7 @@ mod tests {
         String::from_utf8(buf.as_bytes().to_vec()).expect("failed to read record")
     }
 
-    fn write_target(target: &str, fmt: DefaultFormatWriter<'_>) -> String {
+    fn write_target(target: &str, fmt: ConfigurableFormatWriter<'_>) -> String {
         write_record(
             Record::builder()
                 .args(format_args!("log\nmessage"))
@@ -650,7 +650,7 @@ mod tests {
         )
     }
 
-    fn write(fmt: DefaultFormatWriter<'_>) -> String {
+    fn write(fmt: ConfigurableFormatWriter<'_>) -> String {
         write_target("", fmt)
     }
 
@@ -666,8 +666,8 @@ mod tests {
     fn format_with_header() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: true,
                 target: false,
@@ -690,8 +690,8 @@ mod tests {
     fn format_no_header() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: false,
                 target: false,
@@ -714,8 +714,8 @@ mod tests {
     fn format_indent_spaces() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: true,
                 target: false,
@@ -738,8 +738,8 @@ mod tests {
     fn format_indent_zero_spaces() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: true,
                 target: false,
@@ -762,8 +762,8 @@ mod tests {
     fn format_indent_spaces_no_header() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: false,
                 target: false,
@@ -786,8 +786,8 @@ mod tests {
     fn format_suffix() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: false,
                 target: false,
@@ -810,8 +810,8 @@ mod tests {
     fn format_suffix_with_indent() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: false,
                 target: false,
@@ -836,8 +836,8 @@ mod tests {
 
         let written = write_target(
             "target",
-            DefaultFormatWriter {
-                format: &DefaultFormat {
+            ConfigurableFormatWriter {
+                format: &ConfigurableFormat {
                     timestamp: None,
                     module_path: true,
                     target: true,
@@ -861,8 +861,8 @@ mod tests {
     fn format_empty_target() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: true,
                 target: true,
@@ -887,8 +887,8 @@ mod tests {
 
         let written = write_target(
             "target",
-            DefaultFormatWriter {
-                format: &DefaultFormat {
+            ConfigurableFormatWriter {
+                format: &ConfigurableFormat {
                     timestamp: None,
                     module_path: true,
                     target: false,
@@ -912,8 +912,8 @@ mod tests {
     fn format_with_source_file_and_line_number() {
         let mut f = formatter();
 
-        let written = write(DefaultFormatWriter {
-            format: &DefaultFormat {
+        let written = write(ConfigurableFormatWriter {
+            format: &ConfigurableFormat {
                 timestamp: None,
                 module_path: false,
                 target: false,
@@ -946,8 +946,8 @@ mod tests {
 
         let written = write_record(
             record,
-            DefaultFormatWriter {
-                format: &DefaultFormat {
+            ConfigurableFormatWriter {
+                format: &ConfigurableFormat {
                     timestamp: None,
                     module_path: false,
                     target: false,
@@ -983,8 +983,8 @@ mod tests {
 
         let written = write_record(
             record,
-            DefaultFormatWriter {
-                format: &DefaultFormat {
+            ConfigurableFormatWriter {
+                format: &ConfigurableFormat {
                     timestamp: None,
                     module_path: true,
                     target: true,