Struct flexi_logger_rotate_writer::RotateLogWriterBuilder

pub struct RotateLogWriterBuilder { /* fields omitted */ }

Builder for RotateLogWriter.

Implementations

impl RotateLogWriterBuilder

#[must_use]pub const fn print_message(self) -> Self

Makes the RotateLogWriter print an info message to stdout when a new file is used for log-output.

#[must_use]pub fn format(self, format: FormatFunction) -> Self

Makes the RotateLogWriter use the provided format function for the log entries, rather than the default_format.

#[must_use]pub fn directory<P: Into<PathBuf>>(self, directory: P) -> Self

Specifies a folder for the log files.

If the specified folder does not exist, the initialization will fail. By default, the log files are created in the folder where the program was started.

#[must_use]pub fn suffix<S: Into<String>>(self, suffix: S) -> Self

Specifies a suffix for the log files. The default is “log”.

#[must_use]pub fn discriminant<S: Into<String>>(self, discriminant: S) -> Self

The specified String is added to the log file name.

#[must_use]pub fn basename<S: Into<String>>(self, basename: S) -> Self

The specified String is used as the basename of the log file name, instead of the program name.

#[must_use]pub fn create_symlink<P: Into<PathBuf>>(self, symlink: P) -> Self

The specified String will be used on linux systems to create in the current folder a symbolic link to the current log file.

#[must_use]pub const fn use_windows_line_ending(self) -> Self

Use Windows line endings, rather than just \n.

#[must_use]pub const fn use_buffering(self, buffer: bool) -> Self

Define if buffering should be used.

By default, every log line is directly written to the output file, without buffering. This allows seeing new log lines in real time.

#[must_use]pub const fn buffer_with_capacity(self, capacity: usize) -> Self

Activates buffering, and uses a buffer with the specified capacity.

pub fn try_build(self) -> Result<RotateLogWriter, FlexiLoggerError>

Produces the RotateLogWriter.

Trait Implementations

impl Default for RotateLogWriterBuilder

fn default() -> Self

Returns the “default value” for a type.