Struct RollingFileAppender

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

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§

Source§

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

Source

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.

Source

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.

Source

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

Forces a rollover to happen immediately.

Source

pub fn condition_ref(&self) -> &RC

Returns a reference to the rolling condition

Source

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

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

Source

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§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

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

Like write, except that it writes from a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

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

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

Auto Trait Implementations§

§

impl<RC> Freeze for RollingFileAppender<RC>
where RC: Freeze,

§

impl<RC> RefUnwindSafe for RollingFileAppender<RC>
where RC: RefUnwindSafe,

§

impl<RC> Send for RollingFileAppender<RC>
where RC: Send,

§

impl<RC> Sync for RollingFileAppender<RC>
where RC: Sync,

§

impl<RC> Unpin for RollingFileAppender<RC>
where RC: Unpin,

§

impl<RC> UnwindSafe for RollingFileAppender<RC>
where RC: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.