Struct rolling_file::RollingFileAppender

pub struct RollingFileAppender<RC>where
    RC: RollingCondition,{ /* private fields */ }

Writes data to a file, and “rolls over” to preserve older data in a separate set of files. Old files have a Debian-style naming scheme where we have base_filename, base_filename.1, …, base_filename.N where N is the maximum number of rollover files to keep.

Implementations

impl<RC> RollingFileAppender<RC>where
    RC: RollingCondition,

pub fn new<P>(
    path: P,
    condition: RC,
    max_files: usize
) -> Result<RollingFileAppender<RC>>where
    P: AsRef<Path>,

Creates a new rolling file appender with the given condition. The parent directory of the base path must already exist.

pub fn new_with_buffer_capacity<P>(
    path: P,
    condition: RC,
    max_files: usize,
    buffer_capacity: usize
) -> Result<RollingFileAppender<RC>>where
    P: AsRef<Path>,

Creates a new rolling file appender with the given condition and write buffer capacity. The parent directory of the base path must already exist.

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

Forces a rollover to happen immediately.

pub fn condition_ref(&self) -> &RC

Returns a reference to the rolling condition

pub fn condition_mut(&mut self) -> &mut RC

Returns a mutable reference to the rolling condition, possibly to mutate its state dynamically.

pub fn write_with_datetime(
    &mut self,
    buf: &[u8],
    now: &DateTime<Local>
) -> Result<usize>

Writes data using the given datetime to calculate the rolling condition

Trait Implementations

impl<RC> Debug for RollingFileAppender<RC>where
    RC: RollingCondition + Debug,

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

Formats the value using the given formatter.

impl<RC> Write for RollingFileAppender<RC>where
    RC: RollingCondition,

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

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

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

Flush 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, fmt: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

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