Struct spdlog::sink::WriteSink

pub struct WriteSink<W>where
    W: Write + Send,{ /* private fields */ }

A sink that writes log messages into an arbitrary impl Write object.

Performance Notice

Since WriteSink can write into any impl Write objects, the assumptions made on the underlying impl Write object is very weak and this does impact performance. You should use other sinks or implement your own sinks whenever possible. WriteSink is your last resort if no other sinks meet your requirement.

If you want to log into a file, use FileSink or RotatingFileSink instead.

If you want to log into the standard streams, use StdStreamSink instead.

Implementations

impl<W> WriteSink<W>where
    W: Write + Send,

pub fn builder() -> WriteSinkBuilder<W, ()>

Constructs a builder of WriteSink.

pub fn with_target<F, R>(&self, callback: F) -> Rwhere
    F: FnOnce(&mut W) -> R,

Invoke a callback function with the underlying impl Write object.

This function returns whatever the given callback function returns.

Note that this sink cannot write into the underlying impl Write object while the given callback function is running. If the underlying impl Write object supports a relatively cheap clone operation, consider using the clone_target method.

impl<W> WriteSink<W>where
    W: Write + Send + Clone,

pub fn clone_target(&self) -> W

Clone the underlying impl Write object.

Trait Implementations

impl<W> Drop for WriteSink<W>where
    W: Write + Send,

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Sink for WriteSink<W>where
    W: Write + Send,

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

Logs a record.

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

Flushes any buffered records.

fn level_filter(&self) -> LevelFilter

Gets the log level filter.

fn set_level_filter(&self, level_filter: LevelFilter)

Sets the log level filter.

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

Sets the formatter.

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

Sets a error handler.

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

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