Struct loga::types::Log

pub struct Log<F: Flag> { /* private fields */ }

A store of context with methods for logging and creating errors expressing that context.

Unnecessary detail: This is called “Log” because this object will take the place of a log or logger in most code and thus is unlikely to overlap. Naming it “Context” or similar would possibly conflict with other domains’ “context” objects. The two hardest things when programming, as they say - no need to make things harder.

Implementations

impl<F: Flag> Log<F>

pub fn new() -> Self

Create a new logger (defaults to Debug level, change with with_level). You may want to alias this with your flag type of choice.

pub fn fork(&self, attrs: impl Fn(&mut HashMap<&'static str, String>)) -> Self

Create a new Log that inherits attributes from the base logging context. Use like let new_log = log.fork(ea!(newkey = newvalue, ...));.

pub fn with_flags(self, flags: &[F]) -> Self

Initialize or replace flags and return a new Log instance.

pub fn log(&self, flag: F, message: impl ToString)

Log a message. The message will only be rendered and output if any of the specified flags are set.

pub fn log_with( &self, flag: F, message: impl ToString, attrs: impl Fn(&mut HashMap<&'static str, String>) )

Log a message. The attributes will only be evaluated and the message will only be rendered and output if any of the specified flags are set.

pub fn log_err(&self, flag: F, e: Error)

pub fn err(&self, message: impl ToString) -> Error

Create a new error including the attributes in this logging context.

pub fn err_with( &self, message: impl ToString, attrs: impl Fn(&mut HashMap<&'static str, String>) ) -> Error

Create a new error including the attributes in this logging context and merging additional attributes.

pub fn agg_err(&self, message: impl ToString, errs: Vec<Error>) -> Error

Create an error from multiple errors, attaching the Log’s attributes.

pub fn agg_err_with( &self, message: impl ToString, errs: Vec<Error>, attrs: impl Fn(&mut HashMap<&'static str, String>) ) -> Error

Create an error from multiple errors, attaching the Log’s attributes and additional attributes.

Trait Implementations

impl<F: Clone + Flag> Clone for Log<F>

fn clone(&self) -> Log<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Flag> Default for Log<F>

fn default() -> Self

Returns the “default value” for a type.