Struct inotify::Event

pub struct Event<S> {
    pub wd: WatchDescriptor,
    pub mask: EventMask,
    pub cookie: u32,
    pub name: Option<S>,
}

An inotify event

A file system event that describes a change that the user previously registered interest in. To watch for events, call Inotify::add_watch. To retrieve events, call Inotify::read_events_blocking or Inotify::read_events.

Fields

wd: WatchDescriptor

Identifies the watch this event originates from

This WatchDescriptor is equal to the one that Inotify::add_watch returned when interest for this event was registered. The WatchDescriptor can be used to remove the watch using Inotify::rm_watch, thereby preventing future events of this type from being created.

mask: EventMask

Indicates what kind of event this is

cookie: u32

Connects related events to each other

When a file is renamed, this results two events: MOVED_FROM and MOVED_TO. The cookie field will be the same for both of them, thereby making is possible to connect the event pair.

name: Option<S>

The name of the file the event originates from

This field is set only if the subject of the event is a file or directory in a watched directory. If the event concerns a file or directory that is watched directly, name will be None.

Implementations

impl<'a> Event<&'a OsStr>

pub fn into_owned(&self) -> EventOwned

Returns an owned copy of the event.

Trait Implementations

impl<S: Clone> Clone for Event<S>

fn clone(&self) -> Event<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Event<S>

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

Formats the value using the given formatter.