Skip to content

Commit

Permalink
Merge pull request #116 from softdevca/pr-must_use-new
Browse files Browse the repository at this point in the history
The `new` method of loggers are now `#[must_use]`
  • Loading branch information
Drakulix committed Nov 23, 2022
2 parents 626467d + 80242aa commit 5ee5a04
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,5 @@
## Unreleased
- The `new` method of loggers are now `#[must_use]` to prevent confusion when `new` is used called instead of `init`
## v0.12.0
- Replaces the semingly unmainted chrono library with the time crate.
- Addresses through this update
Expand Down
1 change: 1 addition & 0 deletions src/loggers/comblog.rs
Expand Up @@ -74,6 +74,7 @@ impl CombinedLogger {
/// );
/// # }
/// ```
#[must_use]
pub fn new(logger: Vec<Box<dyn SharedLogger>>) -> Box<CombinedLogger> {
let mut log_level = LevelFilter::Off;
for log in &logger {
Expand Down
1 change: 1 addition & 0 deletions src/loggers/simplelog.rs
Expand Up @@ -56,6 +56,7 @@ impl SimpleLogger {
/// let simple_logger = SimpleLogger::new(LevelFilter::Info, Config::default());
/// # }
/// ```
#[must_use]
pub fn new(log_level: LevelFilter, config: Config) -> Box<SimpleLogger> {
Box::new(SimpleLogger {
level: log_level,
Expand Down
1 change: 1 addition & 0 deletions src/loggers/termlog.rs
Expand Up @@ -97,6 +97,7 @@ impl TermLogger {
/// );
/// # }
/// ```
#[must_use]
pub fn new(
log_level: LevelFilter,
config: Config,
Expand Down
1 change: 1 addition & 0 deletions src/loggers/testlog.rs
Expand Up @@ -61,6 +61,7 @@ impl TestLogger {
/// let test_logger = TestLogger::new(LevelFilter::Info, Config::default());
/// # }
/// ```
#[must_use]
pub fn new(log_level: LevelFilter, config: Config) -> Box<TestLogger> {
Box::new(TestLogger {
level: log_level,
Expand Down
1 change: 1 addition & 0 deletions src/loggers/writelog.rs
Expand Up @@ -56,6 +56,7 @@ impl<W: Write + Send + 'static> WriteLogger<W> {
/// let file_logger = WriteLogger::new(LevelFilter::Info, Config::default(), File::create("my_rust_bin.log").unwrap());
/// # }
/// ```
#[must_use]
pub fn new(log_level: LevelFilter, config: Config, writable: W) -> Box<WriteLogger<W>> {
Box::new(WriteLogger {
level: log_level,
Expand Down

0 comments on commit 5ee5a04

Please sign in to comment.