Struct WatchMask

pub struct WatchMask { /* private fields */ }

Describes a file system watch

Passed to Watches::add, to describe what file system events to watch for, and how to do that.

Examples

WatchMask constants can be passed to Watches::add as is. For example, here’s how to create a watch that triggers an event when a file is accessed:

inotify.watches().add("/tmp/inotify-rs-test-file", WatchMask::ACCESS)
   .expect("Error adding watch");

You can also combine multiple WatchMask constants. Here we add a watch this is triggered both when files are created or deleted in a directory:

inotify.watches().add("/tmp/", WatchMask::CREATE | WatchMask::DELETE)
   .expect("Error adding watch");

Implementations

impl WatchMask

pub const ACCESS: WatchMask

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.

pub const ATTRIB: WatchMask

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.

pub const CLOSE_WRITE: WatchMask

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.

pub const CLOSE_NOWRITE: WatchMask

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.

pub const CREATE: WatchMask

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.

pub const DELETE: WatchMask

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.

pub const DELETE_SELF: WatchMask

Watched file/directory was deleted

See inotify_sys::IN_DELETE_SELF.

pub const MODIFY: WatchMask

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.

pub const MOVE_SELF: WatchMask

Watched file/directory was moved

See inotify_sys::IN_MOVE_SELF.

pub const MOVED_FROM: WatchMask

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.

pub const MOVED_TO: WatchMask

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.

pub const OPEN: WatchMask

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.

pub const ALL_EVENTS: WatchMask

Watch for all events

This constant is simply a convenient combination of the following other constants:

• ACCESS
• ATTRIB
• CLOSE_WRITE
• CLOSE_NOWRITE
• CREATE
• DELETE
• DELETE_SELF
• MODIFY
• MOVE_SELF
• MOVED_FROM
• MOVED_TO
• OPEN

See inotify_sys::IN_ALL_EVENTS.

pub const MOVE: WatchMask

Watch for all move events

This constant is simply a convenient combination of the following other constants:

• MOVED_FROM
• MOVED_TO

See inotify_sys::IN_MOVE.

pub const CLOSE: WatchMask

Watch for all close events

This constant is simply a convenient combination of the following other constants:

• CLOSE_WRITE
• CLOSE_NOWRITE

See inotify_sys::IN_CLOSE.

pub const DONT_FOLLOW: WatchMask

Don’t dereference the path if it is a symbolic link

See inotify_sys::IN_DONT_FOLLOW.

pub const EXCL_UNLINK: WatchMask

Filter events for directory entries that have been unlinked

See inotify_sys::IN_EXCL_UNLINK.

pub const MASK_ADD: WatchMask

If a watch for the inode exists, amend it instead of replacing it

See inotify_sys::IN_MASK_ADD.

pub const ONESHOT: WatchMask

Only receive one event, then remove the watch

See inotify_sys::IN_ONESHOT.

pub const ONLYDIR: WatchMask

Only watch path, if it is a directory

See inotify_sys::IN_ONLYDIR.

pub const fn empty() -> WatchMask

Returns an empty set of flags.

pub const fn all() -> WatchMask

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<WatchMask>

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

pub const fn from_bits_truncate(bits: u32) -> WatchMask

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> WatchMask

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: WatchMask) -> bool

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

pub const fn contains(&self, other: WatchMask) -> bool

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

pub fn insert(&mut self, other: WatchMask)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: WatchMask)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: WatchMask)

Toggles the specified flags in-place.

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

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

pub const fn intersection(self, other: WatchMask) -> WatchMask

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: WatchMask) -> WatchMask

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: WatchMask) -> WatchMask

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: WatchMask) -> WatchMask

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> WatchMask

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for WatchMask

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

Formats the value using the given formatter.

impl BitAnd for WatchMask

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

Returns the intersection between the two sets of flags.

type Output = WatchMask

The resulting type after applying the & operator.

impl BitAndAssign for WatchMask

fn bitand_assign(&mut self, other: WatchMask)

Disables all flags disabled in the set.

impl BitOr for WatchMask

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

Returns the union of the two sets of flags.

type Output = WatchMask

The resulting type after applying the | operator.

impl BitOrAssign for WatchMask

fn bitor_assign(&mut self, other: WatchMask)

Adds the set of flags.

impl BitXor for WatchMask

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

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

type Output = WatchMask

The resulting type after applying the ^ operator.

impl BitXorAssign for WatchMask

fn bitxor_assign(&mut self, other: WatchMask)

Toggles the set of flags.

impl Clone for WatchMask

fn clone(&self) -> WatchMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WatchMask

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

Formats the value using the given formatter.

impl Extend<WatchMask> for WatchMask

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = WatchMask>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<WatchMask> for WatchMask

fn from_iter<T>(iterator: T) -> WatchMask

where T: IntoIterator<Item = WatchMask>,

Creates a value from an iterator.

impl Hash for WatchMask

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for WatchMask

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

Formats the value using the given formatter.

impl Not for WatchMask

fn not(self) -> WatchMask

Returns the complement of this set of flags.

type Output = WatchMask

The resulting type after applying the ! operator.

impl Octal for WatchMask

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

Formats the value using the given formatter.

impl Ord for WatchMask

fn cmp(&self, other: &WatchMask) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WatchMask

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WatchMask

fn partial_cmp(&self, other: &WatchMask) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for WatchMask

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

Returns the set difference of the two sets of flags.

type Output = WatchMask

The resulting type after applying the - operator.

impl SubAssign for WatchMask

fn sub_assign(&mut self, other: WatchMask)

Disables all flags enabled in the set.

impl UpperHex for WatchMask

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

Formats the value using the given formatter.

impl Copy for WatchMask

impl Eq for WatchMask

impl StructuralPartialEq for WatchMask