logforth_core/diagnostic/
mod.rs

1// Copyright 2024 FastLabs Developers
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Mapped Diagnostic Context (MDC).
16//!
17//! A lighter technique consists of uniquely stamping each log request.
18
19use std::fmt;
20
21use crate::Error;
22use crate::kv;
23
24mod static_global;
25mod thread_local;
26
27pub use self::static_global::StaticDiagnostic;
28pub use self::thread_local::ThreadLocalDiagnostic;
29
30/// A Mapped Diagnostic Context (MDC) that provides diagnostic key-values.
31pub trait Diagnostic: fmt::Debug + Send + Sync + 'static {
32    /// Visit the MDC key-values with the provided visitor.
33    fn visit(&self, visitor: &mut dyn kv::Visitor) -> Result<(), Error>;
34}
35
36impl<T: Diagnostic> From<T> for Box<dyn Diagnostic> {
37    fn from(value: T) -> Self {
38        Box::new(value)
39    }
40}