maurizi / rsnotify

Cross-platform filesystem notification library for Rust

Notify

NOTICE: I need a usable-in-stable replacement for stat.modified() i.e. a cross-platform way of getting the mtime of a file. Without that, the polling backend will be left out, and I do not currently have the time to do it myself, so please help. Thank you.

Cross-platform filesystem notification library for Rust.

Install

[dependencies]
notify = "^2.0"

Usage

extern crate notify;

use notify::{RecommendedWatcher, Error, Watcher};
use std::sync::mpsc::channel;

fn main() {
  // Create a channel to receive the events.
  let (tx, rx) = channel();

  // Automatically select the best implementation for your platform.
  // You can also access each implementation directly e.g. INotifyWatcher.
  let mut w: Result<RecommendedWatcher, Error> = Watcher::new(tx);

  match w {
    Ok(mut watcher) => {
      // Add a path to be watched. All files and directories at that path and
      // below will be monitored for changes.
      watcher.watch(&Path::new("/home/test/notify"));

      // You'll probably want to do that in a loop. The type to match for is
      // notify::Event, look at src/lib.rs for details.
      match rx.recv() {
        _ => println!("Recv.")
      }
    },
    Err(e) => println!("Error")
  }
}

Platforms

• Linux / Android: inotify
• All platforms: polling (not working, see notice)
• OS X: FSEvent

Todo

• Polling (see notice)
• Windows: ReadDirectoryChangesW (see #4)
• BSD / OS X / iOS: kqueue
• Solaris 11: FEN

Pull requests and bug reports happily accepted!

Origins

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

Written by Félix Saparelli and awesome contributors, and released in the Public Domain using the Creative Commons Zero Declaration.