Enum file_rotator::RotationPeriod

#[non_exhaustive]pub enum RotationPeriod {
    Lines(usize),
    Bytes(usize),
    Interval(Duration),
    Manual,
}

A specifier for how often we should rotate files

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Lines(usize)

Rotate every N line terminato bytes (0x0a, b'\n')

Bytes(usize)

Rotate every N bytes successfully written

This does not count bytes that are not written to the underlying file (when the given buffer's len does not match with the return value of io::Write::write)

Interval(Duration)

Rotate every time N amount of time passes

This is calculated on every write and is based on comparing two Instant::now return values

Manual

Rotate only via RotatingFile::rotate

Trait Implementations

impl Clone for RotationPeriod

fn clone(&self) -> RotationPeriod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RotationPeriod

impl Debug for RotationPeriod

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

Formats the value using the given formatter.

impl Eq for RotationPeriod

impl Ord for RotationPeriod

fn cmp(&self, other: &RotationPeriod) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<RotationPeriod> for RotationPeriod

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

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

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

This method tests for !=.

impl PartialOrd<RotationPeriod> for RotationPeriod

fn partial_cmp(&self, other: &RotationPeriod) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &RotationPeriod) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &RotationPeriod) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &RotationPeriod) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &RotationPeriod) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for RotationPeriod

impl StructuralPartialEq for RotationPeriod