logging-options 0.1.0

Reusable `clap` options for logging (e.g. `--quiet` vs `--debug`) with pluggable logging providers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Traits abstracting the logging [Backend]
//!
//! Applications can just use [Backend::init_from_options].
//!
//! New [Backend] impls need to also implement the other traits here.

/// A logging [Backend] initializes and provides the actual logging functionality
pub trait Backend {
    /// The [BackendBuilder] for [Self]
    type Builder: BackendBuilder;

    /// Given logging options parsed from the commandline, initialize logging
    fn init_from_options<Opts>(opts: &Opts)
    where
        Opts: LoggingOptions<Self>,
    {
        opts.configure(Self::builder()).init();
    }

    /// Get a default-configured builder
    fn builder() -> Self::Builder;
}

/// A [BackendBuilder] can initialize the backend
pub trait BackendBuilder {
    /// Initialize logging for this backend
    fn init(self);
}

/// A set of commandline options which can configure the backend
pub trait LoggingOptions<B>
where
    B: ?Sized + Backend,
{
    /// Configure `B`
    fn configure(&self, builder: B::Builder) -> B::Builder;
}