Struct SinkProp

Source

pub struct SinkProp { /* private fields */ }

Expand description

Contains definitions of sink properties.

It provides a set of common properties for sink to define. If there is no special need for properties, use it directly and then implement GetSinkProp for your sink, a blanket implementation will be enabled, which would eliminate a lot of boilerplate code.

If further customization of the properties is needed (e.g., using different types, changing behavior), this struct is not needed. Instead, define properties manually within your sink, and then implement SinkPropAccess.

Implementations§

Source §

impl SinkProp

Source

pub fn level_filter(&self) -> LevelFilter

Gets the log level filter.

Source

pub fn set_level_filter(&self, level_filter: LevelFilter)

Sets the log level filter.

Source

pub fn formatter<'a>(&'a self) -> impl Deref<Target = dyn Formatter> + 'a

Gets the formatter.

The returned value is a lock guard, so please avoid storing it in a variable with a longer lifetime.

Examples found in repository ?

examples/05-sink.rs (line 39)

35    fn log(&self, record: &Record) -> spdlog::Result<()> {
36        let mut string_buf = StringBuf::new();
37        let mut ctx = FormatterContext::new();
38        self.prop
39            .formatter()
40            .format(record, &mut string_buf, &mut ctx)?;
41        self.collected.lock().unwrap().push(string_buf.to_string());
42        Ok(())
43    }

Source

pub fn set_formatter<F>(&self, formatter: F)
where F: Formatter + 'static,

Sets the formatter.

Source

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

Sets the boxed formatter.

Source

pub fn call_error_handler(&self, err: Error)

Calls the error handler with an error.

Source

pub fn set_error_handler<F: Into<ErrorHandler>>(&self, handler: F)

Sets a error handler.

Most errors that occur in Sink will be returned as directly as possible (e.g. returned to Logger), but some errors that cannot be returned immediately, this function will be called. For example, asynchronous errors.