From aa022fb813420dc90c8be447b60fc9f2c9c04259 Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Tue, 18 Jul 2023 11:41:49 +0200 Subject: [PATCH 1/3] `decoder::log`: Rename `PrettyLogger` to `StdoutLogger`. --- decoder/src/log/json_logger.rs | 6 +++--- decoder/src/log/mod.rs | 6 +++--- decoder/src/log/{pretty_logger.rs => stdout_logger.rs} | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) rename decoder/src/log/{pretty_logger.rs => stdout_logger.rs} (99%) diff --git a/decoder/src/log/json_logger.rs b/decoder/src/log/json_logger.rs index 081ad125..806c780d 100644 --- a/decoder/src/log/json_logger.rs +++ b/decoder/src/log/json_logger.rs @@ -4,11 +4,11 @@ use time::OffsetDateTime; use std::io::{self, Write}; -use super::{pretty_logger::PrettyLogger, DefmtRecord}; +use super::{DefmtRecord, StdoutLogger}; pub(crate) struct JsonLogger { should_log: Box bool + Sync + Send>, - host_logger: PrettyLogger, + host_logger: StdoutLogger, } impl Log for JsonLogger { @@ -44,7 +44,7 @@ impl JsonLogger { pub fn new(should_log: impl Fn(&Metadata) -> bool + Sync + Send + 'static) -> Box { Box::new(Self { should_log: Box::new(should_log), - host_logger: PrettyLogger::new_unboxed(true, |_| true), + host_logger: StdoutLogger::new_unboxed(true, |_| true), }) } diff --git a/decoder/src/log/mod.rs b/decoder/src/log/mod.rs index 338b0ab7..1d01d571 100644 --- a/decoder/src/log/mod.rs +++ b/decoder/src/log/mod.rs @@ -7,14 +7,14 @@ //! [`defmt`]: https://crates.io/crates/defmt mod json_logger; -mod pretty_logger; +mod stdout_logger; use log::{Level, LevelFilter, Metadata, Record}; use serde::{Deserialize, Serialize}; use std::fmt; -use self::{json_logger::JsonLogger, pretty_logger::PrettyLogger}; +use self::{json_logger::JsonLogger, stdout_logger::StdoutLogger}; use crate::Frame; const DEFMT_TARGET_MARKER: &str = "defmt@"; @@ -128,7 +128,7 @@ pub fn init_logger( should_log: impl Fn(&Metadata) -> bool + Sync + Send + 'static, ) { log::set_boxed_logger(match json { - false => PrettyLogger::new(always_include_location, should_log), + false => StdoutLogger::new(always_include_location, should_log), true => { JsonLogger::print_schema_version(); JsonLogger::new(should_log) diff --git a/decoder/src/log/pretty_logger.rs b/decoder/src/log/stdout_logger.rs similarity index 99% rename from decoder/src/log/pretty_logger.rs rename to decoder/src/log/stdout_logger.rs index 57bb29a9..ff125de1 100644 --- a/decoder/src/log/pretty_logger.rs +++ b/decoder/src/log/stdout_logger.rs @@ -10,7 +10,7 @@ use std::{ use super::DefmtRecord; -pub(crate) struct PrettyLogger { +pub(crate) struct StdoutLogger { always_include_location: bool, should_log: Box bool + Sync + Send>, /// Number of characters used by the timestamp. This may increase over time and is used to align @@ -18,7 +18,7 @@ pub(crate) struct PrettyLogger { timing_align: AtomicUsize, } -impl Log for PrettyLogger { +impl Log for StdoutLogger { fn enabled(&self, metadata: &Metadata) -> bool { (self.should_log)(metadata) } @@ -49,7 +49,7 @@ impl Log for PrettyLogger { fn flush(&self) {} } -impl PrettyLogger { +impl StdoutLogger { pub fn new( always_include_location: bool, should_log: impl Fn(&Metadata) -> bool + Sync + Send + 'static, From 931a4c6b376b99cd679e6677671d88be70555959 Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Tue, 18 Jul 2023 11:42:41 +0200 Subject: [PATCH 2/3] Update `CHANGELOG.md` --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c6f326a..d65e48f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +- [#xxx] `decoder::log`: Rename `PrettyLogger` to `StdoutLogger` + +[#xxx]: https://github.com/knurling-rs/defmt/pull/xxx + ## [v0.3.5] - 2023-06-19 - [#760]: `defmt-macros`: Upgrade to syn 2 From c959fed42a7b0b45287b53041ab13a787df077d6 Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Tue, 18 Jul 2023 11:52:31 +0200 Subject: [PATCH 3/3] Update `CHANGELOG.md` --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d65e48f5..d01a2b39 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,9 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] -- [#xxx] `decoder::log`: Rename `PrettyLogger` to `StdoutLogger` +- [#766] `decoder::log`: Rename `PrettyLogger` to `StdoutLogger` -[#xxx]: https://github.com/knurling-rs/defmt/pull/xxx +[#766]: https://github.com/knurling-rs/defmt/pull/766 ## [v0.3.5] - 2023-06-19