Struct EventKindMask 

pub struct EventKindMask(/* private fields */);

A bitmask specifying which event kinds to monitor.

This type allows fine-grained control over which filesystem events are reported. On backends that support kernel-level filtering (inotify), the mask is translated to native flags for optimal performance. On other backends (kqueue, Windows, FSEvents, PollWatcher), filtering is applied in userspace.

Examples

use notify_types::event::EventKindMask;

// Monitor only file creations and deletions
let mask = EventKindMask::CREATE | EventKindMask::REMOVE;

// Monitor everything including access events
let all = EventKindMask::ALL;

// Default: includes all events (matches Config::default())
let default = EventKindMask::default();
assert_eq!(default, EventKindMask::ALL);

Implementations

impl EventKindMask

pub const CREATE: EventKindMask

Monitor file/folder creation events.

pub const REMOVE: EventKindMask

Monitor file/folder removal events.

pub const MODIFY_DATA: EventKindMask

Monitor data modification events (content/size changes).

pub const MODIFY_META: EventKindMask

Monitor metadata modification events (permissions, timestamps, etc).

pub const MODIFY_NAME: EventKindMask

Monitor name/rename events.

pub const ACCESS_OPEN: EventKindMask

Monitor file open events.

pub const ACCESS_CLOSE: EventKindMask

Monitor file close events after writing. This fires when a file opened for writing is closed.

pub const ACCESS_CLOSE_NOWRITE: EventKindMask

Monitor file close events after read-only access. This fires when a file opened for reading (not writing) is closed. Note: This can be very noisy and may cause queue overflow on busy systems.

pub const ALL_MODIFY: EventKindMask

All modify events (data, metadata, and name changes).

pub const ALL_ACCESS: EventKindMask

All access events (open, close-write, and close-nowrite).

pub const CORE: EventKindMask

Core events: create, remove, and all modify events. This is the default and matches the current notify behavior (no access events).

pub const ALL: EventKindMask

All events including access events.

impl EventKindMask

pub const fn empty() -> EventKindMask

Get a flags value with all bits unset.

pub const fn all() -> EventKindMask

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<EventKindMask>

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

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: EventKindMask) -> bool

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

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

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

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

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

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

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: EventKindMask)

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

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

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

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

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

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

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

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

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: EventKindMask) -> EventKindMask

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

pub const fn complement(self) -> EventKindMask

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

impl EventKindMask

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

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<EventKindMask>

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 EventKindMask

pub fn matches(&self, kind: &EventKind) -> bool

Returns whether the given event kind matches this mask.

EventKind::Any and EventKind::Other always pass regardless of the mask, as they represent meta-events that should not be filtered.

Examples

use notify_types::event::{EventKindMask, EventKind, CreateKind, AccessKind, AccessMode};

let mask = EventKindMask::CREATE;
assert!(mask.matches(&EventKind::Create(CreateKind::File)));
assert!(!mask.matches(&EventKind::Access(AccessKind::Open(AccessMode::Read))));

// Any and Other always pass
let empty = EventKindMask::empty();
assert!(empty.matches(&EventKind::Any));
assert!(empty.matches(&EventKind::Other));

Trait Implementations

impl Binary for EventKindMask

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

Formats the value using the given formatter.

impl BitAnd for EventKindMask

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

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

type Output = EventKindMask

The resulting type after applying the & operator.

impl BitAndAssign for EventKindMask

fn bitand_assign(&mut self, other: EventKindMask)

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

impl BitOr for EventKindMask

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

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

type Output = EventKindMask

The resulting type after applying the | operator.

impl BitOrAssign for EventKindMask

fn bitor_assign(&mut self, other: EventKindMask)

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

impl BitXor for EventKindMask

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

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

type Output = EventKindMask

The resulting type after applying the ^ operator.

impl BitXorAssign for EventKindMask

fn bitxor_assign(&mut self, other: EventKindMask)

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

impl Clone for EventKindMask

fn clone(&self) -> EventKindMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventKindMask

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

Formats the value using the given formatter.

impl Default for EventKindMask

fn default() -> EventKindMask

Returns the “default value” for a type.

impl Extend<EventKindMask> for EventKindMask

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

where T: IntoIterator<Item = EventKindMask>,

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 EventKindMask

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

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) -> EventKindMask

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 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<EventKindMask> for EventKindMask

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

where T: IntoIterator<Item = EventKindMask>,

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

impl Hash for EventKindMask

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

type Item = EventKindMask

The type of the elements being iterated over.

type IntoIter = Iter<EventKindMask>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <EventKindMask as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for EventKindMask

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

Formats the value using the given formatter.

impl Not for EventKindMask

fn not(self) -> EventKindMask

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

type Output = EventKindMask

The resulting type after applying the ! operator.

impl Octal for EventKindMask

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

Formats the value using the given formatter.

impl PartialEq for EventKindMask

fn eq(&self, other: &EventKindMask) -> 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 Sub for EventKindMask

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

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 = EventKindMask

The resulting type after applying the - operator.

impl SubAssign for EventKindMask

fn sub_assign(&mut self, other: EventKindMask)

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 EventKindMask

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

Formats the value using the given formatter.

impl Copy for EventKindMask

impl Eq for EventKindMask

impl StructuralPartialEq for EventKindMask