mars-xlog 0.1.0

Pure Rust xlog library with async/sync appenders, compression, encryption, and tracing integration.
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
86
87
88

use std::sync::Arc;

use crate::{AppenderMode, FileIoAction, LogLevel, RawLogMeta, XlogConfig, XlogError};

#[cfg(not(feature = "rust-backend"))]
compile_error!(
    "mars-xlog requires the `rust-backend` feature; the C++ backend is repository-local only"
);

#[cfg(any(
    target_os = "ios",
    target_os = "macos",
    target_os = "tvos",
    target_os = "watchos"
))]
use crate::ConsoleFun;

mod metrics;
mod rust;

pub(crate) trait XlogBackend: Send + Sync {
    fn instance(&self) -> usize;
    fn is_enabled(&self, level: LogLevel) -> bool;
    fn level(&self) -> LogLevel;
    fn set_level(&self, level: LogLevel);
    fn set_appender_mode(&self, mode: AppenderMode);
    fn flush(&self, sync: bool);
    fn set_console_log_open(&self, open: bool);
    fn set_max_file_size(&self, max_bytes: i64);
    fn set_max_alive_time(&self, alive_seconds: i64);
    #[allow(clippy::too_many_arguments)]
    fn write_with_meta(
        &self,
        level: LogLevel,
        tag: &str,
        file: &str,
        func: &str,
        line: u32,
        msg: &str,
        raw_meta: RawLogMeta,
    );
}

pub(crate) trait XlogBackendProvider: Send + Sync {
    fn new_instance(
        &self,
        config: &XlogConfig,
        level: LogLevel,
    ) -> Result<Arc<dyn XlogBackend>, XlogError>;

    fn get_instance(&self, name_prefix: &str) -> Option<Arc<dyn XlogBackend>>;

    fn appender_open(&self, config: &XlogConfig, level: LogLevel) -> Result<(), XlogError>;
    fn appender_close(&self);
    fn flush_all(&self, sync: bool);
    fn global_is_enabled(&self, level: LogLevel) -> bool;
    #[allow(clippy::too_many_arguments)]
    fn write_global_with_meta(
        &self,
        level: LogLevel,
        tag: &str,
        file: &str,
        func: &str,
        line: u32,
        msg: &str,
        raw_meta: RawLogMeta,
    );

    #[cfg(any(
        target_os = "ios",
        target_os = "macos",
        target_os = "tvos",
        target_os = "watchos"
    ))]
    fn set_console_fun(&self, fun: ConsoleFun);

    fn current_log_path(&self) -> Option<String>;
    fn current_log_cache_path(&self) -> Option<String>;
    fn filepaths_from_timespan(&self, timespan: i32, prefix: &str) -> Vec<String>;
    fn make_logfile_name(&self, timespan: i32, prefix: &str) -> Vec<String>;
    fn oneshot_flush(&self, config: &XlogConfig) -> Result<FileIoAction, XlogError>;
    fn dump(&self, buffer: &[u8]) -> String;
    fn memory_dump(&self, buffer: &[u8]) -> String;
}

pub(crate) fn provider() -> &'static dyn XlogBackendProvider {
    rust::provider()
}