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
use std::time::Duration;
/// Runtime configuration for [`crate::Journal`].
///
/// These limits are primarily defensive: they bound memory use and traversal work when reading
/// malformed, truncated, or unexpectedly large journal files.
#[derive(Clone, Debug)]
pub struct JournalConfig {
/// Maximum object size accepted from the journal file.
pub max_object_size_bytes: u64,
/// Maximum bytes allowed after decompressing a DATA payload.
pub max_decompressed_bytes: usize,
/// Maximum length of a field name.
pub max_field_name_len: usize,
/// Maximum number of fields accepted per entry.
pub max_fields_per_entry: usize,
/// Maximum number of journal files included from a single scan.
pub max_journal_files: usize,
/// Maximum number of steps when traversing any `next_*` chain.
pub max_object_chain_steps: usize,
/// Maximum number of query terms (matches) accepted per query.
pub max_query_terms: usize,
/// Whether to allow mmap for `STATE_ONLINE` (potentially still being written) journal files.
pub allow_mmap_online: bool,
/// Whether to include `*.journal~` temporary/incomplete files during discovery.
pub include_journal_tilde: bool,
/// Polling interval used as fallback when inotify is unavailable/unreliable.
pub poll_interval: Duration,
}
impl Default for JournalConfig {
fn default() -> Self {
Self {
max_object_size_bytes: 16 * 1024 * 1024,
max_decompressed_bytes: 1024 * 1024,
max_field_name_len: 128,
max_fields_per_entry: 256,
max_journal_files: 1024,
max_object_chain_steps: 1_000_000,
max_query_terms: 64,
allow_mmap_online: false,
include_journal_tilde: false,
poll_interval: Duration::from_millis(2000),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn default_config_values_are_stable() {
let cfg = JournalConfig::default();
assert_eq!(cfg.max_object_size_bytes, 16 * 1024 * 1024);
assert_eq!(cfg.max_decompressed_bytes, 1024 * 1024);
assert_eq!(cfg.max_field_name_len, 128);
assert_eq!(cfg.max_fields_per_entry, 256);
assert_eq!(cfg.max_journal_files, 1024);
assert_eq!(cfg.max_object_chain_steps, 1_000_000);
assert_eq!(cfg.max_query_terms, 64);
assert!(!cfg.allow_mmap_online);
assert!(!cfg.include_journal_tilde);
assert_eq!(cfg.poll_interval, Duration::from_millis(2000));
}
}