Struct spdlog::sink::WriteSinkBuilder

pub struct WriteSinkBuilder<W, ArgW> { /* private fields */ }

The builder of WriteSink.

Note

The generics here are designed to check for required fields at compile time, users should not specify them manually and/or depend on them. If the generic concrete types or the number of generic types are changed in the future, it may not be considered as a breaking change.

Examples

• Building a WriteSink.

  use spdlog::{prelude::*, sink::WriteSink};
  
  let sink: WriteSink<_> = WriteSink::builder()
      .target(target) // required
      // .level_filter(LevelFilter::MoreSevere(Level::Info)) // optional
      .build()?;

• If any required parameters are missing, a compile-time error will be raised.

  use spdlog::{prelude::*, sink::WriteSink};
  
  let sink: WriteSink<_> = WriteSink::builder()
      // .target(target) // required
      .level_filter(LevelFilter::MoreSevere(Level::Info)) // optional
      .build()?;

Implementations

impl<W, ArgW> WriteSinkBuilder<W, ArgW>where
    W: Write + Send,

pub fn target(self, target: W) -> WriteSinkBuilder<W, PhantomData<W>>

Specifies the target that implemented Write trait, log messages will be written into the target.

This parameter is required.

pub fn level_filter(self, level_filter: LevelFilter) -> Self

Specifies a log level filter.

This parameter is optional, and defaults to LevelFilter::All.

pub fn formatter(self, formatter: Box<dyn Formatter>) -> Self

Specifies a formatter.

This parameter is optional, and defaults to FullFormatter.

pub fn error_handler(self, handler: ErrorHandler) -> Self

Specifies an error handler.

This parameter is optional, and defaults no handler, see Sink::set_error_handler for details.

impl<W> WriteSinkBuilder<W, PhantomData<W>>where
    W: Write + Send,

pub fn build(self) -> Result<WriteSink<W>>

Builds a WriteSink.