Struct XlogConfig 

pub struct XlogConfig {
    pub log_dir: String,
    pub name_prefix: String,
    pub pub_key: Option<String>,
    pub cache_dir: Option<String>,
    pub cache_days: i32,
    pub mode: AppenderMode,
    pub compress_mode: CompressMode,
    pub compress_level: i32,
}

Configuration used to create an Xlog instance or open the global appender.

Fields

log_dir: String

Directory for log files. Must be non-empty.

name_prefix: String

Prefix for log file names and the instance name. Must be non-empty.

pub_key: Option<String>

Optional public key (hex string, 128 chars) enabling log encryption.

cache_dir: Option<String>

Optional cache directory for mmap buffers and temporary logs.

cache_days: i32

Days to keep cached logs before moving them to log_dir.

mode: AppenderMode

Appender mode (async or sync).

compress_mode: CompressMode

Compression algorithm for log buffers/files.

compress_level: i32

Compression level forwarded to the compressor.

Implementations

impl XlogConfig

pub fn new(log_dir: impl Into<String>, name_prefix: impl Into<String>) -> Self

Create a config with required fields and sensible defaults.

pub fn pub_key(self, key: impl Into<String>) -> Self

Set the public key used to encrypt logs.

pub fn cache_dir(self, dir: impl Into<String>) -> Self

Set the optional cache directory for mmap buffers and temp files.

pub fn cache_days(self, days: i32) -> Self

Set the number of days to keep cached logs before moving them.

pub fn mode(self, mode: AppenderMode) -> Self

Set the appender mode.

pub fn compress_mode(self, mode: CompressMode) -> Self

Set the compression algorithm.

pub fn compress_level(self, level: i32) -> Self

Set the compression level forwarded to the compressor.

Trait Implementations

impl Clone for XlogConfig

fn clone(&self) -> XlogConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for XlogConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for XlogConfig

fn eq(&self, other: &XlogConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for XlogConfig

impl StructuralPartialEq for XlogConfig