Struct RotatingFile

pub struct RotatingFile { /* private fields */ }

As per the name, a rotating file

Handles being a fake file which will automagicaly rotate as bytes are written into it

Implementations

impl RotatingFile

pub fn new<Name, Directory>( name: Name, directory: Directory, rotate_every: RotationPeriod, max_files: NonZeroUsize, compression: Compression, ) -> Self

where Name: Into<Cow<'static, str>>, Directory: Into<PathBuf>,

Create a new rotating file with the given base name, in the given directory, rotating every given period and with a max of a given number of files

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

Manually rotate the file out

This is the only way that a file whose rotation_period is RotationPeriod::Manual can rotate.

Errors

Returns an error if one is encountered during creation of the new logfile.

Trait Implementations

impl Debug for RotatingFile

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

Formats the value using the given formatter.

impl Write for RotatingFile

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.