Struct FileSink

pub struct FileSink { /* private fields */ }

A sink with a file as the target.

It writes logs to a single file. If you want to automatically rotate into multiple files, see RotatingFileSink.

The file and directories will be created recursively if they do not exist.

Examples

See ./examples directory.

Implementations

impl FileSink

pub fn builder() -> FileSinkBuilder<()>

Gets a builder of FileSink with default parameters:

Parameter	Default Value
level_filter	All
formatter	FullFormatter
error_handler	default error handler
path	must be specified
truncate	false

pub fn new<P>(path: P, truncate: bool) -> Result<FileSink>

where P: AsRef<Path>,

👎Deprecated since 0.3.0: it may be removed in the future, use FileSink::builder() instead

Constructs a FileSink.

If the parameter truncate is true, the existing contents of the file will be discarded.

Error

If an error occurs opening the file, Error::CreateDirectory or Error::OpenFile will be returned.

Trait Implementations

impl Drop for FileSink

fn drop(&mut self)

Executes the destructor for this type.

impl Sink for FileSink

fn log(&self, record: &Record<'_>) -> Result<()>

Logs a record.

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

Flushes any buffered records.

fn level_filter(&self) -> LevelFilter

Gets the log level filter.

fn set_level_filter(&self, level_filter: LevelFilter)

Sets the log level filter.

fn set_formatter(&self, formatter: Box<dyn Formatter>)

Sets the formatter.

fn set_error_handler(&self, handler: Option<ErrorHandler>)

Sets a error handler.

fn should_log(&self, level: Level) -> bool

Determines if a log message with the specified level would be logged.