Struct flexi_logger::writers::FileLogWriter

pub struct FileLogWriter { /* private fields */ }

A configurable LogWriter implementation that writes to a file or a sequence of files.

See writers for usage guidance.

Implementations

impl FileLogWriter

pub fn builder(file_spec: FileSpec) -> FileLogWriterBuilder

Instantiates a builder for FileLogWriter.

pub fn format(&self) -> FormatFunction

Returns a reference to its configured output format function.

pub fn reset(&self, flwb: &FileLogWriterBuilder) -> Result<(), FlexiLoggerError>

Replaces parts of the configuration of the file log writer.

Note that the write mode and the format function cannot be reset and that the provided FileLogWriterBuilder must have the same values for these as the current FileLogWriter.

Errors

FlexiLoggerError::Reset if a reset was tried with a different write mode.

FlexiLoggerError::Io if the specified path doesn’t work.

FlexiLoggerError::OutputBadDirectory if the specified path is not a directory.

FlexiLoggerError::Poison if some mutex is poisoned.

pub fn config(&self) -> Result<FileLogWriterConfig, FlexiLoggerError>

Returns the current configuration of the file log writer

Errors

FlexiLoggerError::Poison if some mutex is poisoned.

pub fn reopen_outputfile(&self) -> Result<(), FlexiLoggerError>

Makes the FileLogWriter re-open the current log file.

FileLogWriter expects that nobody else modifies the file to which it writes, and offers capabilities to rotate, compress, and clean up log files.

However, if you use tools like linux’ logrotate to rename or delete the current output file, you need to inform the FileLogWriter about such actions by calling this method. Otherwise the FileLogWriter will not stop writing to the renamed or even deleted file!

Example

logrotate e.g. can be configured to send a SIGHUP signal to your program. You should handle SIGHUP in your program explicitly, e.g. using a crate like ctrlc, and call this function from the registered signal handler.

Errors

FlexiLoggerError::Poison if some mutex is poisoned.

pub fn rotate(&self) -> Result<(), FlexiLoggerError>

Trigger an extra log file rotation.

Does nothing if rotation is not configured.

Errors

FlexiLoggerError::Poison if some mutex is poisoned.

IO errors.

pub fn existing_log_files( &self, selector: &LogfileSelector ) -> Result<Vec<PathBuf>, FlexiLoggerError>

Returns the list of existing log files according to the current FileSpec.

The list includes the current log file and the compressed files, if they exist.

Errors

FlexiLoggerError::Poison if some mutex is poisoned.

Trait Implementations

impl Debug for FileLogWriter

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

Formats the value using the given formatter.

impl Drop for FileLogWriter

fn drop(&mut self)

Executes the destructor for this type.

impl LogWriter for FileLogWriter

fn write(&self, now: &mut DeferredNow, record: &Record<'_>) -> Result<()>

Writes out a log line.

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

Flushes any buffered records.

fn max_log_level(&self) -> LevelFilter

Provides the maximum log level that is to be written.

fn reopen_output(&self) -> Result<(), FlexiLoggerError>

Re-open the current output, if meaningful.

fn rotate(&self) -> Result<(), FlexiLoggerError>

Rotate the current output, if meaningful.

fn shutdown(&self)

Cleanup open resources, if necessary.

fn format(&mut self, format: FormatFunction)

Sets the format function.