truefix-log 0.1.4

FIX logging (screen/file/tracing/composite).
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

//! `tracing`-facade log (the SLF4J-equivalent).

use crate::{Log, is_heartbeat};

/// Output switches for [`TracingLog`] (FR-026): `SLF4JLogHeartbeats`. Session-ID prefixing
/// (`SLF4JLogPrependSessionID`) is provided generically by wrapping in [`crate::SessionPrefixLog`]
/// rather than as a field here.
#[derive(Debug, Clone, Copy)]
pub struct TracingLogOptions {
    /// `SLF4JLogHeartbeats`: whether Heartbeat (`35=0`) messages are emitted.
    pub include_heartbeats: bool,
}

impl Default for TracingLogOptions {
    fn default() -> Self {
        Self {
            include_heartbeats: true,
        }
    }
}

/// Logs via the `tracing` facade, separating message and event targets.
pub struct TracingLog {
    options: TracingLogOptions,
}

impl Default for TracingLog {
    fn default() -> Self {
        Self::new()
    }
}

impl TracingLog {
    /// Create a tracing log with default (unfiltered) output switches.
    pub fn new() -> Self {
        Self::with_options(TracingLogOptions::default())
    }

    /// Create a tracing log honoring `options` (FR-026).
    pub fn with_options(options: TracingLogOptions) -> Self {
        Self { options }
    }
}

impl Log for TracingLog {
    fn on_incoming(&self, message: &str) {
        if is_heartbeat(message) && !self.options.include_heartbeats {
            return;
        }
        tracing::info!(target: "truefix::message", direction = "incoming", %message);
    }
    fn on_outgoing(&self, message: &str) {
        if is_heartbeat(message) && !self.options.include_heartbeats {
            return;
        }
        tracing::info!(target: "truefix::message", direction = "outgoing", %message);
    }
    fn on_event(&self, text: &str) {
        tracing::info!(target: "truefix::event", %text);
    }
}