Struct FileWatcher 

pub struct FileWatcher { /* private fields */ }

A polling-based file watcher that tracks modification times.

Call FileWatcher::check_for_changes to perform a single non-blocking scan, or watch_blocking to enter a poll-sleep loop with a rebuild callback.

Implementations

impl FileWatcher

pub fn new(config: WatchConfig) -> Result<Self>

Creates a new FileWatcher and takes an initial snapshot of the watched directory.

Returns an error if the directory does not exist or is unreadable.

Examples

use ssg::watch::{FileWatcher, WatchConfig};
use std::time::Duration;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let cfg = WatchConfig::new(dir.path().to_path_buf(), Duration::from_secs(1));
let watcher = FileWatcher::new(cfg).unwrap();
assert_eq!(watcher.tracked_file_count(), 0);

pub const fn config(&self) -> &WatchConfig

Returns a reference to the watcher’s configuration.

Examples

use ssg::watch::{FileWatcher, WatchConfig};
use std::time::Duration;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let cfg = WatchConfig::new(dir.path().to_path_buf(), Duration::from_secs(1));
let watcher = FileWatcher::new(cfg).unwrap();
assert_eq!(watcher.config().poll_interval(), Duration::from_secs(1));

pub fn check_for_changes(&mut self) -> Result<Vec<PathBuf>>

Performs a single, non-blocking check for file changes.

Scans the watched directory, compares modification times against the internal snapshot, and returns the list of paths that have been added, modified, or removed since the last check.

The internal snapshot is updated to reflect the current state of the filesystem after each call.

Examples

use ssg::watch::{FileWatcher, WatchConfig};
use std::time::Duration;
use tempfile::tempdir;
use std::fs;

let dir = tempdir().unwrap();
let cfg = WatchConfig::new(dir.path().to_path_buf(), Duration::from_secs(1));
let mut watcher = FileWatcher::new(cfg).unwrap();
fs::write(dir.path().join("a.md"), "hi").unwrap();
let changes = watcher.check_for_changes().unwrap();
assert_eq!(changes.len(), 1);

pub fn tracked_file_count(&self) -> usize

Returns the number of files currently tracked in the snapshot.

Examples

use ssg::watch::{FileWatcher, WatchConfig};
use std::time::Duration;
use tempfile::tempdir;

let dir = tempdir().unwrap();
let cfg = WatchConfig::new(dir.path().to_path_buf(), Duration::from_secs(1));
let watcher = FileWatcher::new(cfg).unwrap();
assert_eq!(watcher.tracked_file_count(), 0);

Trait Implementations

impl Debug for FileWatcher

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

Formats the value using the given formatter.