Enum spdlog::sink::RotationPolicy

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

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

impl Clone for RotationPolicy

fn clone(&self) -> RotationPolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RotationPolicy

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

Formats the value using the given formatter.

impl Hash for RotationPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RotationPolicy

fn eq(&self, other: &RotationPolicy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RotationPolicy

impl Eq for RotationPolicy

impl StructuralPartialEq for RotationPolicy