Struct spdlog::sink::RotatingFileSink

pub struct RotatingFileSink { /* private fields */ }

A sink with a file as the target, rotating according to the rotation policy.

Examples

See ./examples directory.

Implementations

impl RotatingFileSink

pub fn new<P>(
    base_path: P,
    rotation_policy: RotationPolicy,
    max_files: usize,
    rotate_on_open: bool
) -> Result<Self> where
    P: Into<PathBuf>, 

Constructs a RotatingFileSink.

The parameter max_files specifies the maximum number of files. If the number of existing files reaches this parameter, the oldest file will be deleted on the next rotation. Pass 0 for no limit.

The parameter rotate_on_open specifies whether to rotate files once when constructing RotatingFileSink. For the RotationPolicy::Daily and RotationPolicy::Hourly rotation policies, it may truncate the contents of the existing file if the parameter is true, since the file name is a time point and not an index.

Errors

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

Panics

Panics if the parameter rotation_policy is invalid. See the documentation of RotationPolicy for requirements.

Trait Implementations

impl Drop for RotatingFileSink

fn drop(&mut self)

Executes the destructor for this type.

impl Sink for RotatingFileSink

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 swap_formatter(&self, formatter: Box<dyn Formatter>) -> Box<dyn Formatter>

Sets the log level filter, and returns the old formatter.

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

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

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

Sets the formatter.