Struct RotatingFileSink

Source
pub struct RotatingFileSink { /* private fields */ }
Expand description

A sink with a file as the target, split files according to the rotation policy.

A service program running for a long time may continuously write logs to a single file, which makes the logs hard to view and manage. RotatingFileSink is designed for this usage scenario. It automatically splits logs into one or more files and can be configured to automatically delete old files to save disk space. The operation of splitting logs into multiple files and optionally deleting old files is called rotation. The rotation policy determines when and how log files are created or deleted.

§Examples

See ./examples directory.

Implementations§

Source§

impl RotatingFileSink

Source

pub fn builder() -> RotatingFileSinkBuilder<(), ()>

Gets a builder of RotatingFileSink with default parameters:

ParameterDefault Value
level_filterAll
formatterFullFormatter
error_handlerdefault error handler
base_pathmust be specified
rotation_policymust be specified
max_files0
rotate_on_openfalse
Source

pub fn new<P>( base_path: P, rotation_policy: RotationPolicy, max_files: usize, rotate_on_open: bool, ) -> Result<Self>
where P: Into<PathBuf>,

👎Deprecated since 0.3.0: it may be removed in the future, use RotatingFileSink::builder() instead

Constructs a RotatingFileSink.

The parameter max_files specifies the maximum number of files. If the number of existing files reaches this parameter, the oldest file will be deleted on the next rotation. Pass 0 for no limit.

The parameter rotate_on_open specifies whether to rotate files once when constructing RotatingFileSink. For the RotationPolicy::Daily, RotationPolicy::Hourly, and RotationPolicy::Period rotation policies, it may truncate the contents of the existing file if the parameter is true, since the file name is a time point and not an index.

§Error

If an error occurs opening the file, Error::CreateDirectory or Error::OpenFile will be returned.

§Panics

Panics if the parameter rotation_policy is invalid. See the documentation of RotationPolicy for requirements.

Trait Implementations§

Source§

impl Drop for RotatingFileSink

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Sink for RotatingFileSink

Source§

fn log(&self, record: &Record<'_>) -> Result<()>

Logs a record.
Source§

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

Flushes any buffered records.
Source§

fn level_filter(&self) -> LevelFilter

Gets the log level filter.
Source§

fn set_level_filter(&self, level_filter: LevelFilter)

Sets the log level filter.
Source§

fn set_formatter(&self, formatter: Box<dyn Formatter>)

Sets the formatter.
Source§

fn set_error_handler(&self, handler: Option<ErrorHandler>)

Sets a error handler. Read more
Source§

fn should_log(&self, level: Level) -> bool

Determines if a log message with the specified level would be logged.

Auto Trait Implementations§

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.