Struct libuv::handles::fs_event::FsEventFlags

pub struct FsEventFlags { /* fields omitted */ }

Flags for FsEventHandle::start()

Implementations

impl FsEventFlags

pub const WATCHENTRY: FsEventFlags

By default, if the fs event watcher is given a directory name, we will watch for all events in that directory. This flags overrides this behavior and makes fs_event report only changes to the directory entry itself. This flag does not affect individual files watched.

This flag is currently not implemented yet on any backend.

pub const STAT: FsEventFlags

By default FsEventHandle will try to use a kernel interface such as inotify or kqueue to detect events. This may not work on remote file systems such as NFS mounts. This flag makes fs_event fall back to calling stat() on a regular interval.

This flag is currently not implemented yet on any backend.

pub const RECURSIVE: FsEventFlags

By default, event watcher, when watching directory, is not registering (is ignoring) changes in its subdirectories.

This flag will override this behaviour on platforms that support it.

pub const fn empty() -> FsEventFlags

Returns an empty set of flags

pub const fn all() -> FsEventFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for FsEventFlags

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

Formats the value using the given formatter.

impl BitAnd<FsEventFlags> for FsEventFlags

type Output = FsEventFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<FsEventFlags> for FsEventFlags

fn bitand_assign(&mut self, other: FsEventFlags)

Disables all flags disabled in the set.

impl BitOr<FsEventFlags> for FsEventFlags

type Output = FsEventFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<FsEventFlags> for FsEventFlags

fn bitor_assign(&mut self, other: FsEventFlags)

Adds the set of flags.

impl BitXor<FsEventFlags> for FsEventFlags

type Output = FsEventFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<FsEventFlags> for FsEventFlags

fn bitxor_assign(&mut self, other: FsEventFlags)

Toggles the set of flags.

impl Clone for FsEventFlags

fn clone(&self) -> FsEventFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FsEventFlags

impl Debug for FsEventFlags

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

Formats the value using the given formatter.

impl Eq for FsEventFlags

impl Extend<FsEventFlags> for FsEventFlags

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

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

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

Creates a value from an iterator.

impl Hash for FsEventFlags

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, 

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

impl LowerHex for FsEventFlags

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

Formats the value using the given formatter.

impl Not for FsEventFlags

type Output = FsEventFlags

The resulting type after applying the ! operator.

fn not(self) -> FsEventFlags

Returns the complement of this set of flags.

impl Octal for FsEventFlags

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

Formats the value using the given formatter.

impl Ord for FsEventFlags

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<FsEventFlags> for FsEventFlags

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

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

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

This method tests for !=.

impl PartialOrd<FsEventFlags> for FsEventFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for FsEventFlags

impl StructuralPartialEq for FsEventFlags

impl Sub<FsEventFlags> for FsEventFlags

type Output = FsEventFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<FsEventFlags> for FsEventFlags

fn sub_assign(&mut self, other: FsEventFlags)

Disables all flags enabled in the set.

impl UpperHex for FsEventFlags

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

Formats the value using the given formatter.