truefix-log 0.1.0

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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Console log.

use crate::{Log, is_heartbeat};

/// Output switches for [`ScreenLog`] (FR-026): `ScreenLogShowEvents`/`ScreenLogShowHeartBeats`/
/// `ScreenLogShowIncoming`/`ScreenLogShowOutgoing`/`ScreenIncludeMilliseconds`.
#[derive(Debug, Clone, Copy)]
pub struct ScreenLogOptions {
    /// `ScreenLogShowEvents`: whether event lines are printed at all.
    pub show_events: bool,
    /// `ScreenLogShowHeartBeats`: whether Heartbeat (`35=0`) messages are printed.
    pub show_heartbeats: bool,
    /// `ScreenLogShowIncoming`: whether inbound messages are printed at all.
    pub show_incoming: bool,
    /// `ScreenLogShowOutgoing`: whether outbound messages are printed at all.
    pub show_outgoing: bool,
    /// `ScreenIncludeMilliseconds`: whether the timestamp prefix includes milliseconds.
    pub include_milliseconds: bool,
}

impl Default for ScreenLogOptions {
    fn default() -> Self {
        Self {
            show_events: true,
            show_heartbeats: true,
            show_incoming: true,
            show_outgoing: true,
            include_milliseconds: false,
        }
    }
}

/// Logs messages to stdout and events to stderr, with direction prefixes.
pub struct ScreenLog {
    options: ScreenLogOptions,
}

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

impl ScreenLog {
    /// Create a screen log with default (unfiltered) output switches.
    pub fn new() -> Self {
        Self::with_options(ScreenLogOptions::default())
    }

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

    fn timestamp_prefix(&self) -> String {
        crate::file::format_timestamp_prefix(self.options.include_milliseconds)
    }
}

impl Log for ScreenLog {
    fn on_incoming(&self, message: &str) {
        if !self.options.show_incoming {
            return;
        }
        if is_heartbeat(message) && !self.options.show_heartbeats {
            return;
        }
        println!("{}<incoming> {message}", self.timestamp_prefix());
    }
    fn on_outgoing(&self, message: &str) {
        if !self.options.show_outgoing {
            return;
        }
        if is_heartbeat(message) && !self.options.show_heartbeats {
            return;
        }
        println!("{}<outgoing> {message}", self.timestamp_prefix());
    }
    fn on_event(&self, text: &str) {
        if !self.options.show_events {
            return;
        }
        eprintln!("{}<event> {text}", self.timestamp_prefix());
    }
}