Enum spdlog::sink::RotationPolicy
source · 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
sourceimpl Clone for RotationPolicy
impl Clone for RotationPolicy
sourcefn clone(&self) -> RotationPolicy
fn clone(&self) -> RotationPolicy
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for RotationPolicy
impl Debug for RotationPolicy
sourceimpl Hash for RotationPolicy
impl Hash for RotationPolicy
sourceimpl PartialEq<RotationPolicy> for RotationPolicy
impl PartialEq<RotationPolicy> for RotationPolicy
sourcefn eq(&self, other: &RotationPolicy) -> bool
fn eq(&self, other: &RotationPolicy) -> bool
impl Copy for RotationPolicy
impl Eq for RotationPolicy
impl StructuralEq for RotationPolicy
impl StructuralPartialEq for RotationPolicy
Auto Trait Implementations
impl RefUnwindSafe for RotationPolicy
impl Send for RotationPolicy
impl Sync for RotationPolicy
impl Unpin for RotationPolicy
impl UnwindSafe for RotationPolicy
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more