Notify

Cross-platform filesystem notification library for Rust.

• Notify Documentation
• Mini Debouncer Documentation
• Full Debouncer Documentation
• Examples
• Changelog
• Upgrading notify from v4
• Earliest supported Rust version: 1.60

As used by: [alacritty], [cargo watch], [cobalt], [docket], [mdBook], [rust-analyzer], [watchexec], [xi-editor], [watchfiles], and others.

(Looking for desktop notifications instead? Have a look at [notify-rust] or [alert-after]!)

Platforms

• Linux / Android: inotify
• macOS: FSEvents or kqueue, see features
• Windows: ReadDirectoryChangesW
• FreeBSD / NetBSD / OpenBSD / DragonflyBSD: kqueue
• All platforms: polling

License

Notify is licensed under the CC Zero 1.0.
notify-debouncer-mini is licensed under the [MIT] or Apache-2.0 license.
notify-debouncer-full is licensed under the [MIT] or Apache-2.0 license.
file-id is licensed under the [MIT] or Apache-2.0 license.

Origins

Inspired by Go's [fsnotify] and Node.js's [Chokidar], born out of need for [cargo watch], and general frustration at the non-existence of C/Rust cross-platform notify libraries.

Originally created by [Félix Saparelli] and awesome [contributors].