Struct inotify::EventMask

pub struct EventMask { /* fields omitted */ }

Indicates the type of an event

This struct can be retrieved from an Event via its mask field. You can determine the Event's type by comparing the EventMask to its associated constants.

Please refer to the documentation of Event for a usage example.

Methods

impl EventMask

const ACCESS: EventMask

ACCESS: EventMask = EventMask{bits: ffi::IN_ACCESS,}

File was accessed

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_ACCESS.

const ATTRIB: EventMask

ATTRIB: EventMask = EventMask{bits: ffi::IN_ATTRIB,}

Metadata (permissions, timestamps, ...) changed

When watching a directory, this event can be triggered for the directory itself, as well as objects inside the directory.

See inotify_sys::IN_ATTRIB.

const CLOSE_WRITE: EventMask

CLOSE_WRITE: EventMask = EventMask{bits: ffi::IN_CLOSE_WRITE,}

File opened for writing was closed

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_CLOSE_WRITE.

const CLOSE_NOWRITE: EventMask

CLOSE_NOWRITE: EventMask = EventMask{bits: ffi::IN_CLOSE_NOWRITE,}

File or directory not opened for writing was closed

When watching a directory, this event can be triggered for the directory itself, as well as objects inside the directory.

See inotify_sys::IN_CLOSE_NOWRITE.

const CREATE: EventMask

CREATE: EventMask = EventMask{bits: ffi::IN_CREATE,}

File/directory created in watched directory

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_CREATE.

const DELETE: EventMask

DELETE: EventMask = EventMask{bits: ffi::IN_DELETE,}

File/directory deleted from watched directory

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_DELETE.

const DELETE_SELF: EventMask

DELETE_SELF: EventMask = EventMask{bits: ffi::IN_DELETE_SELF,}

Watched file/directory was deleted

See inotify_sys::IN_DELETE_SELF.

const MODIFY: EventMask

MODIFY: EventMask = EventMask{bits: ffi::IN_MODIFY,}

File was modified

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_MODIFY.

const MOVE_SELF: EventMask

MOVE_SELF: EventMask = EventMask{bits: ffi::IN_MOVE_SELF,}

Watched file/directory was moved

See inotify_sys::IN_MOVE_SELF.

const MOVED_FROM: EventMask

MOVED_FROM: EventMask = EventMask{bits: ffi::IN_MOVED_FROM,}

File was renamed/moved; watched directory contained old name

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_MOVED_FROM.

const MOVED_TO: EventMask

MOVED_TO: EventMask = EventMask{bits: ffi::IN_MOVED_TO,}

File was renamed/moved; watched directory contains new name

When watching a directory, this event is only triggered for objects inside the directory, not the directory itself.

See inotify_sys::IN_MOVED_TO.

const OPEN: EventMask

OPEN: EventMask = EventMask{bits: ffi::IN_OPEN,}

File or directory was opened

When watching a directory, this event can be triggered for the directory itself, as well as objects inside the directory.

See inotify_sys::IN_OPEN.

const IGNORED: EventMask

IGNORED: EventMask = EventMask{bits: ffi::IN_IGNORED,}

Watch was removed

This event will be generated, if the watch was removed explicitely (via [Inotify::rm_watch]), or automatically (because the file was deleted or the file system was unmounted).

See inotify_sys::IN_IGNORED.

const ISDIR: EventMask

ISDIR: EventMask = EventMask{bits: ffi::IN_ISDIR,}

Event related to a directory

The subject of the event is a directory.

See inotify_sys::IN_ISDIR.

const Q_OVERFLOW: EventMask

Q_OVERFLOW: EventMask = EventMask{bits: ffi::IN_Q_OVERFLOW,}

Event queue overflowed

The event queue has overflowed and events have presumably been lost.

See inotify_sys::IN_Q_OVERFLOW.

const UNMOUNT: EventMask

UNMOUNT: EventMask = EventMask{bits: ffi::IN_UNMOUNT,}

File system containing watched object was unmounted. File system was unmounted

The file system that contained the watched object has been unmounted. An event with WatchMask::IGNORED will subsequently be generated for the same watch descriptor.

See inotify_sys::IN_UNMOUNT.

fn empty() -> EventMask

Returns an empty set of flags.

fn all() -> EventMask

Returns the set containing all flags.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits(bits: u32) -> Option<EventMask>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: u32) -> EventMask

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: EventMask) -> bool

Returns true if there are flags common to both self and other.

fn contains(&self, other: EventMask) -> bool

Returns true all of the flags in other are contained within self.

fn insert(&mut self, other: EventMask)

Inserts the specified flags in-place.

fn remove(&mut self, other: EventMask)

Removes the specified flags in-place.

fn toggle(&mut self, other: EventMask)

Toggles the specified flags in-place.

fn set(&mut self, other: EventMask, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Copy for EventMask

impl PartialEq for EventMask

fn eq(&self, __arg_0: &EventMask) -> bool

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

fn ne(&self, __arg_0: &EventMask) -> bool

This method tests for !=.

impl Eq for EventMask

impl Clone for EventMask

fn clone(&self) -> EventMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for EventMask

fn partial_cmp(&self, __arg_0: &EventMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &EventMask) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &EventMask) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &EventMask) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &EventMask) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for EventMask

fn cmp(&self, __arg_0: &EventMask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for EventMask

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for EventMask

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

Formats the value using the given formatter.

impl Binary for EventMask

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

Formats the value using the given formatter.

impl Octal for EventMask

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

Formats the value using the given formatter.

impl LowerHex for EventMask

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

Formats the value using the given formatter.

impl UpperHex for EventMask

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

Formats the value using the given formatter.

impl BitOr for EventMask

type Output = EventMask

The resulting type after applying the | operator.

fn bitor(self, other: EventMask) -> EventMask

Returns the union of the two sets of flags.

impl BitOrAssign for EventMask

fn bitor_assign(&mut self, other: EventMask)

Adds the set of flags.

impl BitXor for EventMask

type Output = EventMask

The resulting type after applying the ^ operator.

fn bitxor(self, other: EventMask) -> EventMask

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign for EventMask

fn bitxor_assign(&mut self, other: EventMask)

Toggles the set of flags.

impl BitAnd for EventMask

type Output = EventMask

The resulting type after applying the & operator.

fn bitand(self, other: EventMask) -> EventMask

Returns the intersection between the two sets of flags.

impl BitAndAssign for EventMask

fn bitand_assign(&mut self, other: EventMask)

Disables all flags disabled in the set.

impl Sub for EventMask

type Output = EventMask

The resulting type after applying the - operator.

fn sub(self, other: EventMask) -> EventMask

Returns the set difference of the two sets of flags.

impl SubAssign for EventMask

fn sub_assign(&mut self, other: EventMask)

Disables all flags enabled in the set.

impl Not for EventMask

type Output = EventMask

The resulting type after applying the ! operator.

fn not(self) -> EventMask

Returns the complement of this set of flags.

impl Extend<EventMask> for EventMask

fn extend<T: IntoIterator<Item = EventMask>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<EventMask> for EventMask

fn from_iter<T: IntoIterator<Item = EventMask>>(iterator: T) -> EventMask

Creates a value from an iterator.