Skip to content

Commit 4118fd3

Browse files
committed
refactor: DefaultTrap to BestEffortTrap
Signed-off-by: tison <wander4096@gmail.com>
1 parent 3f8dccc commit 4118fd3

File tree

6 files changed

+15
-11
lines changed

6 files changed

+15
-11
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44

55
## Unreleased
66

7+
### Breaking changes
8+
9+
* Rename `DefaultTrap` to `BestEffortTrap` for better clarity.
10+
711
## [0.28.1] 2025-10-06
812

913
### Documentation changes

appenders/async/src/append.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ use logforth_core::Trap;
2121
use logforth_core::kv;
2222
use logforth_core::kv::Visitor;
2323
use logforth_core::record::Record;
24-
use logforth_core::trap::DefaultTrap;
24+
use logforth_core::trap::BestEffortTrap;
2525

2626
use crate::Overflow;
2727
use crate::Task;
@@ -97,7 +97,7 @@ impl AsyncBuilder {
9797
thread_name: thread_name.into(),
9898
appends: vec![],
9999
buffered_lines_limit: None,
100-
trap: Arc::new(DefaultTrap::default()),
100+
trap: Arc::new(BestEffortTrap::default()),
101101
overflow: Overflow::Block,
102102
}
103103
}

appenders/file/src/append.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ impl FileBuilder {
8686
///
8787
/// ```
8888
/// use logforth_append_file::FileBuilder;
89-
/// use logforth_core::trap::DefaultTrap;
89+
/// use logforth_core::trap::BestEffortTrap;
9090
///
9191
/// let builder = FileBuilder::new("my_service", "my_app");
92-
/// builder.trap(DefaultTrap::default());
92+
/// builder.trap(BestEffortTrap::default());
9393
/// ```
9494
pub fn trap(mut self, trap: impl Into<Box<dyn Trap>>) -> Self {
9595
self.builder = self.builder.trap(trap);

appenders/file/src/rolling.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use jiff::Zoned;
2727
use jiff::civil::DateTime;
2828
use logforth_core::Error;
2929
use logforth_core::Trap;
30-
use logforth_core::trap::DefaultTrap;
30+
use logforth_core::trap::BestEffortTrap;
3131

3232
use crate::clock::Clock;
3333
use crate::rotation::Rotation;
@@ -105,7 +105,7 @@ impl RollingFileWriterBuilder {
105105
max_size: None,
106106
max_files: None,
107107
clock: Clock::DefaultClock,
108-
trap: Box::new(DefaultTrap::default()),
108+
trap: Box::new(BestEffortTrap::default()),
109109
}
110110
}
111111

core/src/trap/default.rs renamed to core/src/trap/best_effort.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ use std::io::Write;
1818
use crate::Error;
1919
use crate::trap::Trap;
2020

21-
/// A default trap that sends errors to standard error if possible.
21+
/// A best-effort trap that sends errors to standard error if possible.
2222
///
2323
/// If standard error is not available, it does nothing.
2424
#[derive(Debug, Default)]
2525
#[non_exhaustive]
26-
pub struct DefaultTrap {}
26+
pub struct BestEffortTrap {}
2727

28-
impl Trap for DefaultTrap {
28+
impl Trap for BestEffortTrap {
2929
fn trap(&self, err: &Error) {
3030
let _ = writeln!(io::stderr(), "{err}");
3131
}

core/src/trap/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ use core::fmt;
1818

1919
use crate::Error;
2020

21-
mod default;
21+
mod best_effort;
2222

23-
pub use self::default::DefaultTrap;
23+
pub use self::best_effort::BestEffortTrap;
2424

2525
/// A trap for processing errors.
2626
pub trait Trap: fmt::Debug + Send + Sync + 'static {

0 commit comments

Comments
 (0)