Trait tracing_forest::processor::Processor

source ·

pub trait Processor: 'static + Sized {
    // Required method
    fn process(&self, tree: Tree) -> Result;

    // Provided methods
    fn or<P: Processor>(self, processor: P) -> WithFallback<Self, P> { ... }
    fn or_stdout(self) -> WithFallback<Self, Printer<Pretty, MakeStdout>> { ... }
    fn or_stderr(self) -> WithFallback<Self, Printer<Pretty, MakeStderr>> { ... }
    fn or_none(self) -> WithFallback<Self, Sink> { ... }
}

Expand description

A trait for processing completed Trees.

Processors are responsible for both formatting and writing logs to their intended destinations. This is typically implemented using Formatter, MakeWriter, and io::Write.

While this trait may be implemented on downstream types, from_fn provides a convenient interface for creating Processors without having to explicitly define new types.

Required Methods§

source

fn process(&self, tree: Tree) -> Result

Process a Tree. This can mean many things, such as writing to stdout or a file, sending over a network, storing in memory, ignoring, or anything else.

Errors

If the Tree cannot be processed, then it is returned along with a Box<dyn Error + Send + Sync>. If the processor is configured with a fallback processor from Processor::or, then the Tree is deferred to that processor.