Struct inotify_sys::inotify_event

#[repr(C)]
pub struct inotify_event {
    pub wd: c_int,
    pub mask: uint32_t,
    pub cookie: uint32_t,
    pub len: uint32_t,
}

Describes a file system event

From inotify(7):

To determine what events have occurred, an application read(2)s from the inotify file descriptor. If no events have so far occurred, then, assuming a blocking file descriptor, read(2) will block until at least one event occurs (unless interrupted by a signal, in which case the call fails with the error EINTR; see signal(7)).

Each successful read(2) returns a buffer containing one or more of this structure.

Fields

wd: c_int

Identifies the watch for which this event occurs

This is one of the watch descriptors returned by a previous call to inotify_add_watch().

mask: uint32_t

Describes the type file system event

One of the following bits will be set, to identify the type of event:

• IN_ACCESS
• IN_ATTRIB
• IN_CLOSE_NOWRITE
• IN_CLOSE_WRITE
• IN_CREATE
• IN_DELETE
• IN_DELETE_SELF
• IN_IGNORED
• IN_MODIFY
• IN_MOVED_FROM
• IN_MOVED_TO
• IN_MOVE_SELF
• IN_OPEN
• IN_Q_OVERFLOW
• IN_UNMOUNT

Some constants cover multiple bits, and can be used for a less precise check of the event type:

• IN_CLOSE
• IN_MOVE

In addition, the IN_ISDIR bit can be set.

cookie: uint32_t

A number that connects related events

Currently used only for rename events. A related pair of IN_MOVED_FROM and IN_MOVED_TO events will have the same, non-zero, cookie. For all other events, cookie is 0.

len: uint32_t

The length of name

Used to determine the size of this structure. When name isn't present (name is only present when an event occurs for a file inside a watched directory), it is 0. When name is present, it counts all of name's bytes, including \0.

The name field is present only when an event is returned for a file inside a watched directory; it identifies the file pathname relative to the watched directory. This pathname is null-terminated, and may include further null bytes ('\0') to align subsequent reads to a suitable address boundary.

The name field has been ommited in this struct's definition.

Trait Implementations

impl Clone for inotify_event

fn clone(&self) -> inotify_event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for inotify_event

impl Debug for inotify_event

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

Formats the value using the given formatter.