Struct Watcher

pub struct Watcher<H: WatcherHandler> { /* private fields */ }

A file watcher that monitors specified files for changes and notifies a handler when updates occur.

Implementations

impl<H: WatcherHandler> Watcher<H>

pub async fn new( platform: Platform, poll_interval: u64, handler: H, ) -> Result<Self, Error>

Creates a new Watcher instance that monitors configuration files for changes.

Parameters

• platform: The target platform for which the configuration state should be monitored.
• poll_interval: Time interval (in milliseconds) to check for file changes.
• handler: An instance implementing WatcherHandler for handling snapshots and errors.

Returns

• Ok(Self): A properly initialized Watcher instance.
• Err(Error): If any file metadata cannot be retrieved.

pub async fn watch(&mut self)

Starts monitoring the files and system state for changes.

This function continuously checks the monitored files for modifications and observes system state transitions. When a file modification or a relevant state transition (from Draft to Applied) is detected, it triggers the on_snapshot method of the handler.

Returns

• Ok(()) if the monitoring process runs smoothly.
• Err(Error) if an unrecoverable error occurs.

pub async fn check_files_for_changes(&mut self) -> bool

Checks the monitored files for modifications.

pub async fn handle_snapshot(&mut self)

Captures and processes a snapshot of the monitored files and system state.

pub async fn snapshot(&self) -> Result<Snapshot, Error>

Generates a snapshot of the current state of the monitored files.

Returns

• Ok(Snapshot): A snapshot containing the contents and metadata of monitored files.
• Err(Error): If a file cannot be read.

pub async fn force_capture_and_dispatch(&self) -> Result<(), Error>

Forces the capture of a snapshot and dispatches it to the handler.

Returns

• Ok(()) if the snapshot was successfully processed by the handler.
• Err(Error): If an error occurs during snapshot creation or handling.