Filesystem watcher library
- Rust 99.8%
- Shell 0.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
79007aefb4
Some checks failed
CI / zizmor (push) Has been cancelled
CI / Quality Checks (push) Has been cancelled
CI / Test macos-latest - 1.88 (--no-default-features --features macos_fsevent) (push) Has been cancelled
CI / Test macos-latest - nightly (--no-default-features --features macos_fsevent) (push) Has been cancelled
CI / Test macos-latest - stable (--no-default-features --features macos_fsevent) (push) Has been cancelled
CI / Test macos-latest - 1.88 (--no-default-features --features macos_kqueue) (push) Has been cancelled
CI / Test macos-latest - nightly (--no-default-features --features macos_kqueue) (push) Has been cancelled
CI / Test macos-latest - stable (--no-default-features --features macos_kqueue) (push) Has been cancelled
CI / Test ubuntu-latest - 1.88 (push) Has been cancelled
CI / Test ubuntu-latest - nightly (push) Has been cancelled
CI / Test ubuntu-latest - stable (push) Has been cancelled
CI / Test windows-latest - 1.88 (push) Has been cancelled
CI / Test windows-latest - nightly (push) Has been cancelled
CI / Test windows-latest - stable (push) Has been cancelled
CI / FreeBSD - 1.88 (push) Has been cancelled
CI / FreeBSD - nightly (push) Has been cancelled
CI / FreeBSD - stable (push) Has been cancelled
CI / Android (push) Has been cancelled
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com> |
||
| .github | ||
| docs | ||
| examples | ||
| file-id | ||
| notify | ||
| notify-debouncer-full | ||
| notify-debouncer-mini | ||
| notify-types | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .typos.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| clippy.toml | ||
| CODE_OF_CONDUCT.md | ||
| deny.toml | ||
| README.md | ||
| release_checklist.md | ||
| renovate.json | ||
| rust-toolchain.toml | ||
Notify
Cross-platform filesystem notification library for Rust.
- Notify Documentation
- Notify Types Documentation
- Mini Debouncer Documentation
- Full Debouncer Documentation
- File ID
- Examples
- Changelog
- Upgrading notify from v8
- Upgrading notify from v4
- Minimum supported Rust version: 1.88
As used by: alacritty, cargo watch, cobalt, deno, docket, mdBook, rust-analyzer, watchexec, watchfiles, xi-editor, zed and others.
(Looking for desktop notifications instead? Have a look at notify-rust or alert-after!)
Minimum Supported Rust Version (MSRV) Policy
We follow these MSRV rules:
- The current MSRV is 1.88.
- MSRV bumps do NOT require a major release and may happen in minor releases.
- The MSRV may be updated when needed, but support for the current stable Rust release and the previous two stable releases (N, N-1, N-2) is always guaranteed.
- For example, if the current stable version is 1.85, we guarantee support for 1.85, 1.84, and 1.83, so the minimum supported Rust version will be at most 1.83.
- MSRV is bumped only when needed, e.g.:
- required by dependencies
- any serious bug is found (including security-related)
- adopting new stable Rust features
- Every MSRV bump is documented in the release notes when it happens.
Platforms
- Linux / Android: inotify
- macOS: FSEvents or kqueue, see features
- Windows: ReadDirectoryChangesW
- iOS / FreeBSD / NetBSD / OpenBSD / DragonflyBSD: kqueue
- All platforms: polling
License
notify is licensed under the CC Zero 1.0.
notify-types is licensed under the MIT or Apache-2.0 license.
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.