Struct FileRotate

pub struct FileRotate<S: SuffixScheme> { /* private fields */ }

The main writer used for rotating logs.

Implementations

impl<S: SuffixScheme> FileRotate<S>

pub fn new<P: AsRef<Path>>( path: P, suffix_scheme: S, content_limit: ContentLimit, compression: Compression, open_options: Option<OpenOptions>, ) -> Self

Create a new FileRotate.

The basename of the path is used to create new log files by appending an extension of the form .N, where N is 0..=max_files.

content_limit specifies the limits for rotating a file.

open_options: If provided, you must set .read(true).create(true).append(true)!

Panics

Panics if bytes == 0 or lines == 0.

pub fn log_paths(&mut self) -> Vec<PathBuf>

Get paths of rotated log files (excluding the original/current log file), ordered from oldest to most recent

pub fn rotate(&mut self) -> Result<()>

Trigger a log rotation manually. This is mostly intended for use with ContentLimit::None but will work with all content limits.

Trait Implementations

impl<S: Debug + SuffixScheme> Debug for FileRotate<S>

where S::Repr: Debug,

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

Formats the value using the given formatter.

impl<S: SuffixScheme> Write for FileRotate<S>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.