Struct FileBuilder 

pub struct FileBuilder { /* private fields */ }

A builder to configure and create an File appender.

See module-level documentation for usage examples.

Implementations

impl FileBuilder

pub fn new(basedir: impl Into<PathBuf>, filename: impl Into<String>) -> Self

Create a new file appender builder.

pub fn build(self) -> Result<File, Error>

Build the File appender.

Errors

Return an error if either:

• The log directory cannot be created.
• The configured filename is empty.

pub fn layout(self, layout: impl Into<Box<dyn Layout>>) -> Self

Set the layout for the logs.

Default to PlainTextLayout.

Examples

use logforth_append_file::FileBuilder;
use logforth_layout_json::JsonLayout;

let builder = FileBuilder::new("my_service", "my_app");
builder.layout(JsonLayout::default());

pub fn trap(self, trap: impl Into<Box<dyn Trap>>) -> Self

Set the trap for the file writer.

Default to BestEffortTrap.

Examples

use logforth_append_file::FileBuilder;
use logforth_core::trap::BestEffortTrap;

let builder = FileBuilder::new("my_service", "my_app");
builder.trap(BestEffortTrap::default());

pub fn rollover_minutely(self) -> Self

Set the rotation strategy to roll over log files minutely.

pub fn rollover_hourly(self) -> Self

Set the rotation strategy to roll over log files hourly.

pub fn rollover_daily(self) -> Self

Set the rotation strategy to roll over log files daily at 00:00 in the local time zone.

pub fn rollover_size(self, n: NonZeroUsize) -> Self

Set the rotation strategy to roll over log files if the current log file exceeds the given size.

If any time-based rotation strategy is set, the size-based rotation will be checked on the current log file after the time-based rotation check.

pub fn filename_suffix(self, suffix: impl Into<String>) -> Self

Set the filename suffix.

pub fn max_log_files(self, n: NonZeroUsize) -> Self

Set the maximum number of log files to keep.

Trait Implementations

impl Debug for FileBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.