Enum Cleanup

pub enum Cleanup {
    Never,
    KeepLogFiles(usize),
    KeepCompressedFiles(usize),
    KeepLogAndCompressedFiles(usize, usize),
}

Defines the strategy for handling older log files.

Is used in Logger::rotate.

Note that if you use a strategy other than Cleanup::Never, then the cleanup work is by default done in an extra thread, to minimize the impact on the program.

See LoggerHandle::shutdown to avoid interrupting a currently active cleanup when your program terminates.

See Logger::cleanup_in_background_thread if you want to control whether this extra thread is created and used.

Variants

Never

Older log files are not touched - they remain for ever.

KeepLogFiles(usize)

The specified number of rotated log files are kept. Older files are deleted, if necessary.

KeepCompressedFiles(usize)

Available on crate feature compress only.

The specified number of rotated log files are compressed and kept. Older files are deleted, if necessary.

KeepLogAndCompressedFiles(usize, usize)

Available on crate feature compress only.

Allows keeping some files as text files and some as compressed files.

Example

KeepLogAndCompressedFiles(5,30) ensures that the youngest five log files are kept as text files, the next 30 are kept as compressed files with additional suffix .gz, and older files are removed.

Trait Implementations

impl Clone for Cleanup

fn clone(&self) -> Cleanup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cleanup

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

Formats the value using the given formatter.

impl Copy for Cleanup