pub enum RotationPolicy {
    FileSize(u64),
    Daily {
        hour: u32,
        minute: u32,
    },
    Hourly,
}
Expand description

Rotation policies for RotatingFileSink.

Rotation policy defines when and how to split log messages into log files, during which new log files may be created and old log files may be deleted. Currently spdlog provides 3 different rotation policies:

  • Rotate by file size, which is represented by the RotationPolicy::FileSize variant. Under this rotation policy, the sink rotates log messages when the size of the current log file exceeds a limit. The sink will then create a new log file for further log messages and may optionally delete the oldest log files depending on the maximum number of files allowed.
  • Rotate daily, which is represented by the RotationPolicy::Daily variant. Under this rotation policy, the sink automatically creates a new log file at a specified time point within a day. The oldest log files may be deleted, depending on the maximum number of allowed log files.
  • Rotate hourly, which is represented by the RotationPolicy::Hourly variant. Under this rotation policy, the sink automatically creates a new log file at a specified time point within each hour. The oldest log files may be deleted, depending on the maximum number of allowed log files.

Errors

Note that some parameters have range requirements, functions that receive it will return an error if the requirements are not met.

Variants

FileSize(u64)

Tuple Fields

0: u64

Max file size (in bytes). Range: (0, u64::MAX].

Rotates when the log file reaches the given max file size.

Daily

Fields

hour: u32

Hour of the time point. Range: [0, 23].

minute: u32

Minute of the time point. Range: [0, 59].

Rotates daily at the given time point.

Hourly

Rotates hourly.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.