Struct Config

Source

pub struct Config { /* private fields */ }

Expand description

Watcher Backend configuration

This contains multiple settings that may relate to only one specific backend, such as to correctly configure each backend regardless of what is selected during runtime.

let config = Config::default()
    .with_poll_interval(Duration::from_secs(2))
    .with_compare_contents(true);

Some options can be changed during runtime, others have to be set when creating the watcher backend.

Implementations§

Source §

impl Config

Source

pub fn with_poll_interval(self, dur: Duration) -> Self

For the PollWatcher backend.

Interval between each re-scan attempt. This can be extremely expensive for large file trees so it is recommended to measure and tune accordingly.

The default poll frequency is 30 seconds.

This will enable automatic polling, overwriting with_manual_polling().

Source

pub fn poll_interval(&self) -> Option<Duration>

Returns current setting

Source

pub fn with_manual_polling(self) -> Self

For the PollWatcher backend.

Disable automatic polling. Requires calling crate::PollWatcher::poll() manually.

This will disable automatic polling, overwriting with_poll_interval().

Source

pub fn with_compare_contents(self, compare_contents: bool) -> Self

For the PollWatcher backend.

Optional feature that will evaluate the contents of changed files to determine if they have indeed changed using a fast hashing algorithm. This is especially important for pseudo filesystems like those on Linux under /sys and /proc which are not obligated to respect any other filesystem norms such as modification timestamps, file sizes, etc. By enabling this feature, performance will be significantly impacted as all files will need to be read and hashed at each poll_interval.

This can’t be changed during runtime. Off by default.

Source

pub fn compare_contents(&self) -> bool

Returns current setting

Source

pub fn with_follow_symlinks(self, follow_symlinks: bool) -> Self

For the INotifyWatcher, KqueueWatcher, and PollWatcher.

Determine if symbolic links should be followed when recursively watching a directory.

This can’t be changed during runtime. On by default.

Source

pub fn follow_symlinks(&self) -> bool

Returns current setting

Source

pub fn with_event_kinds(self, event_kinds: EventKindMask) -> Self

Filter which event kinds are monitored.

This allows you to control which types of filesystem events are delivered to your event handler. On backends that support kernel-level filtering (inotify), the mask is translated to native flags for optimal performance. On other backends (kqueue, Windows, FSEvents, PollWatcher), filtering is applied in userspace.

The default is EventKindMask::ALL, which includes all events. Use EventKindMask::CORE to exclude access events.

This can’t be changed during runtime.

§Example

use notify::{Config, EventKindMask};

// Only monitor file creation and deletion
let config = Config::default()
    .with_event_kinds(EventKindMask::CREATE | EventKindMask::REMOVE);

// Monitor everything including access events
let config_all = Config::default()
    .with_event_kinds(EventKindMask::ALL);

Source

pub fn event_kinds(&self) -> EventKindMask

Returns current setting

Source

pub fn with_windows_path_separator_style( self, style: WindowsPathSeparatorStyle, ) -> Self

For the ReadDirectoryChangesWatcher backend.

Controls path separator normalization for emitted event paths on Windows.

The default is WindowsPathSeparatorStyle::Auto, which preserves the separator style implied by each watched input path.

This can’t be changed during runtime.

Source

pub fn windows_path_separator_style(&self) -> WindowsPathSeparatorStyle

Returns current setting.

Source

pub fn with_fsevent_latency(self, latency: Duration) -> Self

For the FsEventWatcher backend.

The latency passed to FSEventStreamCreate: how long the FSEvents service waits after hearing about an event from the kernel before invoking the callback. A larger value lets the system coalesce bursts of changes into fewer callbacks at the cost of higher delivery latency.

This watcher is created with kFSEventStreamCreateFlagNoDefer, so the first event in an idle period is delivered immediately; only subsequent events get coalesced within the latency window.

The default is Duration::ZERO.

This can’t be changed during runtime.

Source