tracing-subscriber-init 0.2.1

A trait and some functions to make tracing subscriber initialization a bit easier
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

// Copyright (c) 2023 tracing-subscriber-init developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

use tracing_subscriber::fmt::format::FmtSpan;

/// Implement this trait to supply tracing configuration that can be used to build a [`Layer`](tracing_subscriber::Layer)
/// with functions such as [`full_filtered`](crate::full_filtered).
pub trait Config {
    /// Get the quiet count (these are normally pulled from the command line arguments)
    fn quiet(&self) -> u8;
    /// Get the verbose count (these are normally pulled from the command line arguments)
    fn verbose(&self) -> u8;
    /// Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting.
    /// This defaults to true
    fn with_ansi(&self) -> bool {
        true
    }
    /// Sets whether or not the formatter will include the current span in formatted events.
    /// This defaults to false
    #[cfg(feature = "json")]
    #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
    fn with_current_span(&self) -> bool {
        false
    }
    /// Sets whether or not an event’s source code file path is displayed.
    /// This defaults to false
    fn with_file(&self) -> bool {
        false
    }
    /// Sets whether or not an event’s source code line number is displayed.
    /// This defaults to false
    fn with_line_number(&self) -> bool {
        false
    }
    /// Sets whether or not an event’s level is displayed.
    /// This defaults to true
    fn with_level(&self) -> bool {
        true
    }
    /// Configures how synthesized events are emitted at points in the span lifecycle.
    /// This defaults to [`None`](std::option::Option::None).
    /// See [`with_span_event`](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/struct.Layer.html#method.with_span_events)
    fn with_span_events(&self) -> Option<FmtSpan> {
        None
    }
    /// Sets whether or not the formatter will include a list (from root to leaf) of all currently entered spans in formatted events.
    /// This defaults to false
    #[cfg(feature = "json")]
    #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
    fn with_span_list(&self) -> bool {
        false
    }
    /// Sets whether or not an event’s target is displayed.
    /// This defaults to false
    fn with_target(&self) -> bool {
        false
    }
    /// Sets whether or not the thread ID of the current thread is displayed when formatting events.
    /// This defaults to false
    fn with_thread_ids(&self) -> bool {
        false
    }
    /// Sets whether or not the name of the current thread is displayed when formatting events.
    /// This defaults to false
    fn with_thread_names(&self) -> bool {
        false
    }
}