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: Self

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: Self

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: Self

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: Self

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: Self

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: Self

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: Self

Watched file/directory was deleted

See inotify_sys::IN_DELETE_SELF.

pub const MODIFY: Self

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: Self

Watched file/directory was moved

See inotify_sys::IN_MOVE_SELF.

pub const MOVED_FROM: Self

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: Self

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: Self

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: Self

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: Self

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: Self

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: Self

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

See inotify_sys::IN_DONT_FOLLOW.

pub const EXCL_UNLINK: Self

Filter events for directory entries that have been unlinked

See inotify_sys::IN_EXCL_UNLINK.

pub const MASK_ADD: Self

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

See inotify_sys::IN_MASK_ADD.

pub const ONESHOT: Self

Only receive one event, then remove the watch

See inotify_sys::IN_ONESHOT.

pub const ONLYDIR: Self

Only watch path, if it is a directory

See inotify_sys::IN_ONLYDIR.

impl WatchMask

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl WatchMask

pub const fn iter(&self) -> Iter<WatchMask>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<WatchMask>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl WatchMask

pub unsafe fn from_bits_unchecked(bits: u32) -> Self

👎Deprecated:

Use the safe from_bits_retain method instead

Wrapper around Self::from_bits_retain for backwards compatibility

Safety

This function is not actually unsafe. It is just a wrapper around the safe Self::from_bits_retain.

Trait Implementations

impl Binary for WatchMask

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

Formats the value using the given formatter.

impl BitAnd for WatchMask

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

The bitwise and (&) of the bits in two flags values.

type Output = WatchMask

The resulting type after applying the & operator.

impl BitAndAssign for WatchMask

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for WatchMask

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

The bitwise or (|) of the bits in two flags values.

type Output = WatchMask

The resulting type after applying the | operator.

impl BitOrAssign for WatchMask

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for WatchMask

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = WatchMask

The resulting type after applying the ^ operator.

impl BitXorAssign for WatchMask

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for WatchMask

fn clone(&self) -> WatchMask

Returns a duplicate 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

Formats the value using the given formatter.

impl Extend<WatchMask> for WatchMask

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

The bitwise or (|) of the bits in each flags value.

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 Flags for WatchMask

const FLAGS: &'static [Flag<WatchMask>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> WatchMask

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<WatchMask> for WatchMask

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

The bitwise or (|) of the bits in each flags value.

impl Hash for WatchMask

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

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 IntoIterator for WatchMask

type Item = WatchMask

The type of the elements being iterated over.

type IntoIter = Iter<WatchMask>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for WatchMask

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

Formats the value using the given formatter.

impl Not for WatchMask

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = WatchMask

The resulting type after applying the ! operator.

impl Octal for WatchMask

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

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 PublicFlags for WatchMask

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for WatchMask

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = WatchMask

The resulting type after applying the - operator.

impl SubAssign for WatchMask

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for WatchMask

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

Formats the value using the given formatter.

impl Copy for WatchMask

impl Eq for WatchMask

impl StructuralPartialEq for WatchMask