Enum hotwatch::Event

pub enum Event {
    NoticeWrite(PathBuf),
    NoticeRemove(PathBuf),
    Create(PathBuf),
    Write(PathBuf),
    Chmod(PathBuf),
    Remove(PathBuf),
    Rename(PathBuf, PathBuf),
    Rescan,
    Error(Error, Option<PathBuf>),
}

Event delivered when action occurs on a watched path in debounced mode

Variants

NoticeWrite(PathBuf)

NoticeWrite is emitted immediately after the first write event for the path.

If you are reading from that file, you should probably close it immediately and discard all data you read from it.

Tuple Fields of NoticeWrite

0: PathBuf

NoticeRemove(PathBuf)

NoticeRemove is emitted immediately after a remove or rename event for the path.

The file will continue to exist until its last file handle is closed.

Tuple Fields of NoticeRemove

0: PathBuf

Create(PathBuf)

Create is emitted when a file or directory has been created and no events were detected for the path within the specified time frame.

Create events have a higher priority than Write and Chmod. These events will not be emitted if they are detected before the Create event has been emitted.

Tuple Fields of Create

0: PathBuf

Write(PathBuf)

Write is emitted when a file has been written to and no events were detected for the path within the specified time frame.

Write events have a higher priority than Chmod. Chmod will not be emitted if it’s detected before the Write event has been emitted.

Upon receiving a Create event for a directory, it is necessary to scan the newly created directory for contents. The directory can contain files or directories if those contents were created before the directory could be watched, or if the directory was moved into the watched directory.

Tuple Fields of Write

0: PathBuf

Chmod(PathBuf)

Chmod is emitted when attributes have been changed and no events were detected for the path within the specified time frame.

Tuple Fields of Chmod

0: PathBuf

Remove(PathBuf)

Remove is emitted when a file or directory has been removed and no events were detected for the path within the specified time frame.

Tuple Fields of Remove

0: PathBuf

Rename(PathBuf, PathBuf)

Rename is emitted when a file or directory has been moved within a watched directory and no events were detected for the new path within the specified time frame.

The first path contains the source, the second path the destination.

Tuple Fields of Rename

0: PathBuf1: PathBuf

Rescan

Rescan is emitted immediately after a problem has been detected that makes it necessary to re-scan the watched directories.

Error(Error, Option<PathBuf>)

Error is emitted immediately after a error has been detected.

This event may contain a path for which the error was detected.

Tuple Fields of Error

0: Error1: Option<PathBuf>

Trait Implementations

impl Debug for DebouncedEvent

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<DebouncedEvent> for DebouncedEvent

pub fn eq(&self, other: &DebouncedEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.