Negahban

🧐 A simple file watcher, based on notify, designed to be fast, easy-to-use and async friendly. Project is alpha, it may fail at any given moment, heavily WIP

Name 😀

Negahban(نگهبان) is a farsi word which translates roughly to watchman/sentinel

Overview 📊

negahban is a Rust library based on notify that allows you to watch a directory for changes.

This library is designed to be:

• Simple, Sane defaults 🌱
• Blazing Fast 🚀
• Async friendly 🔀
• Cross-platform 🌐

Features ✨

• Supports multiple event types such as file creation, deletion, and modification.
• Provides HookType, WatchMode, and RecurseMode configuration options.
• Can ignore specific files and directories.
• Easy to use and async friendly.

Usage 🔨

Add this to your Cargo.toml:

toml [dependencies] negahban = "x.x.x" # last semver instead of x.x.x

A minimal example that monitors the current directory and logs events to the console:

```rust use negahban::Negahban;

fn main() { Negahban{ // fields you want to change e.g.: hook: Box::new(|event, _| (println!("{:#?}", event))), ..Negahban::default() // sets rest of them to default }.watch(); } ```

Examples 👨‍💻

See the examples/ directory for more examples.

License ⚖

This project is licensed under the MIT License - see the LICENSE file for details.