Trait LogWriter

Source
pub trait LogWriter: Sync + Send {
    // Required methods
    fn write(
        &self,
        now: &mut DeferredNow,
        record: &Record<'_>,
    ) -> Result<(), Error>;
    fn flush(&self) -> Result<(), Error>;

    // Provided methods
    fn max_log_level(&self) -> LevelFilter { ... }
    fn format(
        &mut self,
        format: fn(&mut dyn Write, &mut DeferredNow, &Record<'_>) -> Result<(), Error>,
    ) { ... }
    fn shutdown(&self) { ... }
    fn reopen_output(&self) -> Result<(), FlexiLoggerError> { ... }
    fn rotate(&self) -> Result<(), FlexiLoggerError> { ... }
}
Expand description

Writes to a single log output stream.

Boxed instances of LogWriter can be used as additional log targets (see writers for more details).

Required Methods§

Source

fn write(&self, now: &mut DeferredNow, record: &Record<'_>) -> Result<(), Error>

Writes out a log line.

§Errors

std::io::Error

Source

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

Flushes any buffered records.

§Errors

std::io::Error

Provided Methods§

Source

fn max_log_level(&self) -> LevelFilter

Provides the maximum log level that is to be written.

Source

fn format( &mut self, format: fn(&mut dyn Write, &mut DeferredNow, &Record<'_>) -> Result<(), Error>, )

Sets the format function.

Defaults to default_format, but can be changed with a call to Logger::format_for_writer.

The default implementation is a no-op.

Source

fn shutdown(&self)

Cleanup open resources, if necessary.

Source

fn reopen_output(&self) -> Result<(), FlexiLoggerError>

Re-open the current output, if meaningful.

This method is called from LoggerHandle::reopen_output for all registered additional writers.

§Errors

Depend on registered writers.

Source

fn rotate(&self) -> Result<(), FlexiLoggerError>

Rotate the current output, if meaningful.

This method is called from LoggerHandle::trigger_rotation for all registered additional writers.

§Errors

Depend on registered writers.

Implementors§