Struct ConfigWatcher 

pub struct ConfigWatcher { /* private fields */ }

Configuration watcher for hot reload support.

This struct manages configuration file watching and event distribution. The actual file system watching should be implemented at the application level using this struct to distribute events.

Implementations

impl ConfigWatcher

pub fn new() -> ConfigWatcher

Create a new configuration watcher.

pub fn with_debounce(debounce_ms: u64) -> ConfigWatcher

Create a new configuration watcher with custom debounce duration.

pub fn state(&self) -> WatcherState

Get the current state.

pub fn start(&self)

Start the watcher.

pub fn stop(&self)

Stop the watcher.

pub fn pause(&self)

Pause the watcher (events are still received but not processed).

pub fn resume(&self)

Resume the watcher.

pub fn register(&self, source: ConfigSource)

Register a configuration source to watch.

pub fn unregister(&self, path: &PathBuf)

Unregister a configuration source.

pub fn sources(&self) -> Vec<ConfigSource>

Get all registered sources.

pub fn subscribe(&self) -> Receiver<ConfigEvent>

Subscribe to configuration events.

pub fn emit(&self, event: ConfigEvent)

Emit a configuration event.

This method should be called by the file system watcher implementation. Events are debounced based on the configured duration.

pub fn emit_modified(&self, source: ConfigSource)

Emit a modification event for a source.

pub fn emit_reloaded(&self, source: ConfigSource)

Emit a reload success event.

pub fn emit_error( &self, source: Option<ConfigSource>, message: impl Into<String>, )

Emit an error event.

Trait Implementations

impl Default for ConfigWatcher

fn default() -> ConfigWatcher

Returns the “default value” for a type.