Struct StdStreamSinkBuilder 

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

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.

Implementations

impl<ArgSS> StdStreamSinkBuilder<ArgSS>

pub fn stdout(self) -> StdStreamSinkBuilder<StdStream>

Specifies the target standard stream as stdout.

This is equivalent to std_stream(StdStream::Stdout).

pub fn stderr(self) -> StdStreamSinkBuilder<StdStream>

Specifies the target standard stream as stderr.

This is equivalent to std_stream(StdStream::Stderr).

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 via_print_macro(self) -> Self

Specifies to use print! and eprint! macros for output.

If enabled, the sink will use print! and eprint! macros instead of io::Write trait with io::stdout and io::stderr to output logs. This is useful if you want the logs to be captured by cargo test and cargo bench.

This parameter is optional, and defaults to false, or defaults to true if feature gate std-stream-captured is enabled.

A convienient way to enable it for cargo test and cargo bench is to add the following lines to your Cargo.toml:

# Note that it's not [dependencies]

[dev-dependencies]
spdlog-rs = { version = "...", features = ["std-stream-captured"] }

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<F>(self, formatter: F) -> Self

where F: Formatter + 'static,

Specifies a formatter.

This parameter is optional, and defaults to FullFormatter.

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

Specifies an error handler.

This parameter is optional, and defaults to ErrorHandler::default().

impl StdStreamSinkBuilder<StdStream>

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

Builds a StdStreamSink.

pub fn build_arc(self) -> Result<Arc<StdStreamSink>>

Builds a Arc<StdStreamSink>.

This is a shorthand method for .build().map(Arc::new).