Struct spdlog::sink::StdStreamSinkBuilder

pub struct StdStreamSinkBuilder<ArgSS> { /* private fields */ }

The builder of StdStreamSink.

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 StdStreamSink.

  use spdlog::{
      sink::{StdStreamSink, StdStream},
      terminal_style::StyleMode
  };
  
  let sink: StdStreamSink = StdStreamSink::builder()
      .std_stream(StdStream::Stdout) // required
      /* .style_mode(StyleMode::Never) // optional, defaults to
                                       // `StyleMode::Auto` */
      .build()?;

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

  use spdlog::{
      sink::{StdStreamSink, StdStream},
      terminal_style::StyleMode
  };
  
  let sink: StdStreamSink = StdStreamSink::builder()
      // .std_stream(StdStream::Stdout) // required
      .style_mode(StyleMode::Never) /* optional, defaults to
                                     * `StyleMode::Auto` */
      .build()?;

Implementations

impl<ArgSS> StdStreamSinkBuilder<ArgSS>

pub fn std_stream(self, std_stream: StdStream) -> StdStreamSinkBuilder<StdStream>

Specifies the target standard stream.

This parameter is required.

pub fn style_mode(self, style_mode: StyleMode) -> Self

Specifies the style mode.

This parameter is optional, and defaults to StyleMode::Auto.

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 StdStreamSinkBuilder<StdStream>

pub fn build(self) -> Result<StdStreamSink>

Builds a StdStreamSink.