Struct spirit_log::background::Background

pub struct Background { /* fields omitted */ }

A Transformation to move loggers into background threads.

By default, loggers created by the Pipeline are synchronous ‒ they block to do their IO. This puts the IO into a separate thread, with a buffer in between, allowing the rest of the application not to block.

The same warnings about lost messages and flushing as in the AsyncLogger case apply here. However, the Extensible::keep_guard and spirit::Extensible::autojoin_bg_thread can be used with the FlushGuard to ensure this happens automatically (the FlushGuard also implements Extension, which takes care of the setup).

Examples

use log::info;
use serde::Deserialize;
use spirit::{Empty, Pipeline, Spirit};
use spirit::prelude::*;
use spirit_log::{Background, Cfg as LogCfg, FlushGuard, OverflowMode};

#[derive(Clone, Debug, Default, Deserialize)]
struct Cfg {
    #[serde(default, skip_serializing_if = "LogCfg::is_empty")]
    logging: LogCfg,
}

impl Cfg {
    fn logging(&self) -> LogCfg {
        self.logging.clone()
    }
}

fn main() {
    Spirit::<Empty, Cfg>::new()
        .with(
            Pipeline::new("logging")
                .extract_cfg(Cfg::logging)
                .transform(Background::new(100, OverflowMode::Block)),
        )
        .with_singleton(FlushGuard)
        .run(|_spirit| {
            info!("Hello world");
            Ok(())
        });
}

Implementations

impl Background

pub fn new(buffer: usize, mode: OverflowMode) -> Self

Creates a new Background object.

Params

• buffer: How many messages fit into the channel to the background thread.
• mode: What to do if the current message does not fit.

Trait Implementations

impl Clone for Background

fn clone(&self) -> Background

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Background

impl Debug for Background

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Background

impl Hash for Background

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Background

fn cmp(&self, other: &Background) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Background> for Background

fn eq(&self, other: &Background) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Background) -> bool

This method tests for !=.

impl PartialOrd<Background> for Background

fn partial_cmp(&self, other: &Background) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Background) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Background) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Background) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Background) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Background

impl StructuralPartialEq for Background

impl<I, F> Transformation<Dispatch, I, F> for Background

type OutputResource = (LevelFilter, Box<dyn Log>)

The type of resource after the transformation.

type OutputInstaller = I

The type of installer after the transformation.

fn installer(&mut self, original: I, _name: &'static str) -> I

Creates the installer.

fn transform(
    &mut self,
    dispatch: Dispatch,
    _fragment: &F,
    _name: &'static str
) -> Result<(LevelFilter, Box<dyn Log>), AnyError>

Transforms one instance of the resource.