zccache 1.10.0

Local-first compiler cache for C/C++/Rust/Emscripten
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

//! File watcher for zccache.
//!
//! Provides cross-platform file watching with settle/coalesce buffering,
//! directory ignore filtering, and integration with the metadata cache's
//! clock-based change tracking.
//!
//! Architecture:
//! ```text
//! notify (OS thread) → mpsc → SettleBuffer (tokio task) → CacheSystem
//! ```

#![allow(clippy::missing_errors_doc)]

pub mod ignore;
pub mod notify_watcher;
pub mod polling_watcher;
pub mod recovery;
pub mod settle;

use crate::core::NormalizedPath;

pub use ignore::IgnoreFilter;
pub use notify_watcher::NotifyWatcher;
pub use polling_watcher::{
    PollWatchBatch, PollWatchObserver, PollingWatcher, PollingWatcherConfig,
};
pub use recovery::OverflowRecovery;
pub use settle::{SettleBuffer, SettledEvent};

/// Events produced by the file watcher.
#[derive(Debug, Clone)]
pub enum WatchEvent {
    /// A file was modified.
    Modified(NormalizedPath),
    /// A file was created.
    Created(NormalizedPath),
    /// A file was removed.
    Removed(NormalizedPath),
    /// A file was renamed (from, to).
    Renamed {
        from: NormalizedPath,
        to: NormalizedPath,
    },
    /// The watcher's event buffer overflowed. All watched paths
    /// should be considered stale.
    Overflow,
    /// An error occurred in the watcher backend.
    Error(String),
}

/// Configuration for the file watcher.
#[derive(Debug, Clone)]
pub struct WatcherConfig {
    /// Settle window in milliseconds.
    pub settle_window_ms: u64,
    /// Directory patterns to ignore.
    pub ignore_patterns: Vec<String>,
}

impl Default for WatcherConfig {
    fn default() -> Self {
        Self {
            settle_window_ms: 50,
            ignore_patterns: IgnoreFilter::default_patterns(),
        }
    }
}