logforth_core/append/
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//! Dispatch log records to various targets.
16
17use std::fmt;
18
19use crate::Diagnostic;
20use crate::Error;
21use crate::record::Record;
22
23mod stdio;
24mod testing;
25
26pub use self::stdio::Stderr;
27pub use self::stdio::Stdout;
28pub use self::testing::Testing;
29
30/// An appender that can process log records.
31pub trait Append: fmt::Debug + Send + Sync + 'static {
32    /// Dispatch a log record to the append target.
33    fn append(&self, record: &Record, diags: &[Box<dyn Diagnostic>]) -> Result<(), Error>;
34
35    /// Flush any buffered records.
36    fn flush(&self) -> Result<(), Error>;
37
38    /// Perform any cleanup work before the program exits.
39    ///
40    /// Default to call `flush`.
41    ///
42    /// This is typically called within a global logger during program exits.
43    /// If it is not in a global logger, the drop glue should perform necessary
44    /// cleanup.
45    fn exit(&self) -> Result<(), Error> {
46        self.flush()
47    }
48}
49
50impl<T: Append> From<T> for Box<dyn Append> {
51    fn from(value: T) -> Self {
52        Box::new(value)
53    }
54}
logforth_core/append/mod.rs

logforth_core/append/
mod.rs
