Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain how watch does not follow moves or renames #166

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,13 @@ pub trait Watcher: Sized {
///
/// If the `path` is a file, `recursive_mode` will be ignored and events will be delivered only
/// for the file.
///
/// If the `path` is renamed (moved) or deleted, it will automatically be unwatched. I.e.
/// watch does not follow moved directories or files. (This is independent of the underlying
/// OS library used by notify.) If at a later point another file or directory is moved into
/// the same location, it will not be automatically watched. If you need that behaviour, it is
/// recommended that you also watch the parent directory non-recursively and implement an
/// opportunistic watcher yourself.
fn watch<P: AsRef<Path>>(&mut self, path: P, recursive_mode: RecursiveMode) -> Result<()>;

/// Stop watching a path.
Expand Down