1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
//! Cross-platform file system notification library //! //! # Installation //! //! ```toml //! [dependencies] //! notify = "5.0.0-pre.7" //! ``` //! //! ## Serde //! //! Events are serialisable via [serde] if the `serde` feature is enabled: //! //! ```toml //! notify = { version = "5.0.0-pre.7", features = ["serde"] } //! ``` //! //! [serde]: https://serde.rs //! //! # Examples //! //! ``` //! use notify::{Watcher, RecommendedWatcher, RecursiveMode, Result}; //! //! fn main() -> Result<()> { //! // Automatically select the best implementation for your platform. //! let mut watcher: RecommendedWatcher = Watcher::new_immediate(|res| { //! match res { //! Ok(event) => println!("event: {:?}", event), //! Err(e) => println!("watch error: {:?}", e), //! } //! })?; //! //! // Add a path to be watched. All files and directories at that path and //! // below will be monitored for changes. //! watcher.watch(".", RecursiveMode::Recursive)?; //! //! Ok(()) //! } //! ``` //! //! ## With precise events //! //! By default, Notify emits non-descript events containing only the affected path and some //! metadata. To get richer details about _what_ the events are about, you need to enable //! [`Config::PreciseEvents`](config/enum.Config.html#variant.PreciseEvents). The full event //! classification is described in the [`event`](event/index.html) module documentation. //! //! ``` //! # use notify::{Watcher, RecommendedWatcher, RecursiveMode, Result}; //! # use std::time::Duration; //! # fn main() -> Result<()> { //! # // Automatically select the best implementation for your platform. //! # let mut watcher: RecommendedWatcher = Watcher::new_immediate(|res| { //! # match res { //! # Ok(event) => println!("event: {:?}", event), //! # Err(e) => println!("watch error: {:?}", e), //! # } //! # })?; //! //! # // Add a path to be watched. All files and directories at that path and //! # // below will be monitored for changes. //! # watcher.watch(".", RecursiveMode::Recursive)?; //! //! use notify::Config; //! watcher.configure(Config::PreciseEvents(true))?; //! //! # Ok(()) //! # } //! //! ``` //! //! ## With different configurations //! //! It is possible to create several watchers with different configurations or implementations that //! all call the same event function. This can accommodate advanced behaviour or work around limits. //! //! ``` //! # use notify::{RecommendedWatcher, RecursiveMode, Result, Watcher}; //! # //! # fn main() -> Result<()> { //! fn event_fn(res: Result<notify::Event>) { //! match res { //! Ok(event) => println!("event: {:?}", event), //! Err(e) => println!("watch error: {:?}", e), //! } //! } //! //! let mut watcher1: RecommendedWatcher = Watcher::new_immediate(event_fn)?; //! let mut watcher2: RecommendedWatcher = Watcher::new_immediate(event_fn)?; //! # watcher1.watch(".", RecursiveMode::Recursive)?; //! # watcher2.watch(".", RecursiveMode::Recursive)?; //! # //! # Ok(()) //! # } //! ``` // FIXME: `anymap` crate triggers this lint and we cannot do anything here. #![allow(where_clauses_object_safety)] #![deny(missing_docs)] pub use config::{Config, RecursiveMode}; pub use error::{Error, ErrorKind, Result}; pub use event::{Event, EventKind}; use std::convert::AsRef; use std::path::Path; #[cfg(target_os = "macos")] pub use crate::fsevent::FsEventWatcher; #[cfg(target_os = "linux")] pub use crate::inotify::INotifyWatcher; pub use null::NullWatcher; pub use poll::PollWatcher; #[cfg(target_os = "windows")] pub use windows::ReadDirectoryChangesWatcher; #[cfg(target_os = "macos")] pub mod fsevent; #[cfg(target_os = "linux")] pub mod inotify; #[cfg(target_os = "windows")] pub mod windows; pub mod event; pub mod null; pub mod poll; mod config; mod error; /// The set of requirements for watcher event handling functions. pub trait EventFn: 'static + Fn(Result<Event>) + Send {} impl<F> EventFn for F where F: 'static + Fn(Result<Event>) + Send {} /// Type that can deliver file activity notifications /// /// Watcher is implemented per platform using the best implementation available on that platform. /// In addition to such event driven implementations, a polling implementation is also provided /// that should work on any platform. pub trait Watcher: Sized { /// Create a new watcher in _immediate_ mode. /// /// Events will be sent using the provided `tx` immediately after they occur. fn new_immediate<F>(event_fn: F) -> Result<Self> where F: EventFn; /// Begin watching a new path. /// /// If the `path` is a directory, `recursive_mode` will be evaluated. If `recursive_mode` is /// `RecursiveMode::Recursive` events will be delivered for all files in that tree. Otherwise /// only the directory and its immediate children will be watched. /// /// If the `path` is a file, `recursive_mode` will be ignored and events will be delivered only /// for the file. /// /// On some platforms, if the `path` is renamed or removed while being watched, behaviour may /// be unexpected. See discussions in [#165] and [#166]. If less surprising behaviour is wanted /// one may non-recursively watch the _parent_ directory as well and manage related events. /// /// [#165]: https://github.com/notify-rs/notify/issues/165 /// [#166]: https://github.com/notify-rs/notify/issues/166 fn watch<P: AsRef<Path>>(&mut self, path: P, recursive_mode: RecursiveMode) -> Result<()>; /// Stop watching a path. /// /// # Errors /// /// Returns an error in the case that `path` has not been watched or if removing the watch /// fails. fn unwatch<P: AsRef<Path>>(&mut self, path: P) -> Result<()>; /// Configure the watcher at runtime. /// /// See the [`Config`](config/enum.Config.html) enum for all configuration options. /// /// # Returns /// /// - `Ok(true)` on success. /// - `Ok(false)` if the watcher does not support or implement the option. /// - `Err(notify::Error)` on failure. fn configure(&mut self, _option: Config) -> Result<bool> { Ok(false) } } /// The recommended `Watcher` implementation for the current platform #[cfg(target_os = "linux")] pub type RecommendedWatcher = INotifyWatcher; /// The recommended `Watcher` implementation for the current platform #[cfg(target_os = "macos")] pub type RecommendedWatcher = FsEventWatcher; /// The recommended `Watcher` implementation for the current platform #[cfg(target_os = "windows")] pub type RecommendedWatcher = ReadDirectoryChangesWatcher; /// The recommended `Watcher` implementation for the current platform #[cfg(not(any(target_os = "linux", target_os = "macos", target_os = "windows")))] pub type RecommendedWatcher = PollWatcher; /// Convenience method for creating the `RecommendedWatcher` for the current platform in /// _immediate_ mode. /// /// See [`Watcher::new_immediate`](trait.Watcher.html#tymethod.new_immediate). pub fn immediate_watcher<F>(event_fn: F) -> Result<RecommendedWatcher> where F: EventFn, { Watcher::new_immediate(event_fn) }