Struct FileHandler

pub struct FileHandler { /* private fields */ }

A handler that writes log records to a file

Implementations

impl FileHandler

pub fn new(path: impl AsRef<Path>) -> Result<Self>

pub fn with_level(self, level: LogLevel) -> Self

pub fn with_formatter(self, formatter: Formatter) -> Self

pub fn with_colors(self, use_colors: bool) -> Self

pub fn with_pattern(self, pattern: impl Into<String>) -> Self

pub fn with_format<F>(self, format_fn: F) -> Self

where F: Fn(&Record) -> String + Send + Sync + 'static,

pub fn with_rotation(self, max_size: usize, max_files: usize) -> Self

pub fn with_filter(self, filter: HandlerFilter) -> Self

pub fn with_compression(self, compress: bool) -> Self

pub fn with_batching(self, batch_size: usize) -> Self

Trait Implementations

impl Clone for FileHandler

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileHandler

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

Formats the value using the given formatter.

impl Handler for FileHandler

fn handle(&self, record: &Record) -> Result<(), HandlerError>

Handle a log record

fn level(&self) -> LogLevel

Get the log level

fn set_level(&mut self, level: LogLevel)

Set the log level

fn is_enabled(&self) -> bool

Check if the handler is enabled

fn set_enabled(&mut self, enabled: bool)

Set whether the handler is enabled

fn formatter(&self) -> &Formatter

Get the formatter

fn set_formatter(&mut self, formatter: Formatter)

Set the formatter

fn set_filter(&mut self, filter: Option<HandlerFilter>)

Set a filter closure for this handler (optional, default: no filter)

fn filter(&self) -> Option<&HandlerFilter>

Get the filter closure for this handler (optional)

fn handle_batch(&self, records: &[Record]) -> Result<(), HandlerError>

Handle a batch of log records (optimized implementation)

fn init(&mut self) -> Result<(), HandlerError>

Lifecycle: initialize the handler

fn flush(&self) -> Result<(), HandlerError>

Lifecycle: flush the handler

fn shutdown(&mut self) -> Result<(), HandlerError>

Lifecycle: shutdown the handler