logforth_core/layout/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//! Layouts for formatting log records.
16
17use std::fmt;
18
19use crate::Diagnostic;
20use crate::Error;
21use crate::record::Record;
22
23mod plain_text;
24
25pub use self::plain_text::PlainTextLayout;
26
27/// A layout for formatting log records.
28pub trait Layout: fmt::Debug + Send + Sync + 'static {
29 /// Format a log record with optional diagnostics.
30 fn format(&self, record: &Record, diags: &[Box<dyn Diagnostic>]) -> Result<Vec<u8>, Error>;
31}
32
33impl<T: Layout> From<T> for Box<dyn Layout> {
34 fn from(value: T) -> Self {
35 Box::new(value)
36 }
37}