Enum RotationPolicy

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

Rotation policies for RotatingFileSink.

Rotation policy defines when and how to split logs into multiple files, during which new log files may be created and old log files may be deleted.

Error

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

Examples

use spdlog::sink::RotationPolicy;

// Rotating every 10 MB file.
RotationPolicy::FileSize(1024 * 1024 * 10);

// Rotating every day at 15:30.
RotationPolicy::Daily { hour: 15, minute: 30 };

// Rotating every hour.
RotationPolicy::Hourly;

// Rotating every 6 hour.
RotationPolicy::Period(Duration::from_secs(6 * 60 * 60));

Variants

FileSize(u64)

Rotating to a new log file when the size of the current log file exceeds the given limit.

Tuple Fields

0: u64

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

Daily

Rotating to a new log file at a specified time point within a day.

Fields

hour: u32

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

minute: u32

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

Hourly

Rotating to a new log file at minute 0 of each hour.

Period(Duration)

Rotating to a new log file after given period (greater then 1 minute) is passed.

Tuple Fields

0: Duration

Period to the next rotation. Range: [1 minute, Duration::MAX].

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

Tests for self and other values to be equal, and is used by ==.

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

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