bp3d_debug/logger/
interface.rs

1// Copyright (c) 2024, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use crate::field::Field;
30use crate::logger::Level;
31use crate::util::Location;
32use std::fmt::Arguments;
33
34pub struct Callsite {
35    location: Location,
36    level: Level,
37}
38
39impl Callsite {
40    pub const fn new(location: Location, level: Level) -> Self {
41        Self { location, level }
42    }
43
44    pub fn location(&self) -> &Location {
45        &self.location
46    }
47
48    pub fn level(&self) -> Level {
49        self.level
50    }
51}
52
53pub trait Logger {
54    fn log(&self, callsite: &'static Callsite, msg: Arguments, fields: &[Field]);
55}
56
57#[cfg(test)]
58mod tests {
59    use crate::logger::Level;
60    use crate::{log, trace};
61
62    #[test]
63    fn api_test() {
64        let tuple = (41, 42);
65        let i = 42;
66        let b = true;
67        log!(Level::Info, { i }, "test: {i}: {}", i);
68        log!(Level::Error, "test: {}", i);
69        trace!({i} {?i} {id=i}, "test: {}", i);
70        trace!("test: {}, {}", i, i);
71        trace!("test41_42: {}, {}", tuple.0, tuple.1);
72        trace!({ b }, "a boolean");
73    }
74}
bp3d_debug/logger/interface.rs

bp3d_debug/logger/
interface.rs
