Struct NotifyFilter 

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

Which changes a watch reports.

A thin newtype over FILE_NOTIFY_CHANGE rather than an enum, because the value is a bitmask and Windows may define bits this crate has not heard of. The named constants are provided for convenience; an unknown bit still reaches Windows unaltered.

Example

use windows_namespace_request_sys::watch::NotifyFilter;

let combined = NotifyFilter::FILE_NAME | NotifyFilter::DIR_NAME;

assert!(combined.contains(NotifyFilter::FILE_NAME));
assert!(!combined.contains(NotifyFilter::SIZE));

// A bitmask, not an enum: a bit Windows defines and this crate has never
// heard of still reaches it.
let unknown = NotifyFilter::from_bits(0x8000_0000);
assert_eq!(unknown.bits(), 0x8000_0000);

// The empty filter watches nothing, and Windows -- not this crate --
// rejects it at the call.
assert_eq!(NotifyFilter::NONE.bits(), 0);

Implementations

impl NotifyFilter

pub const NONE: Self

An empty filter, which watches for nothing.

Windows rejects this at the call, which is left to happen rather than pre-empted here.

pub const FILE_NAME: Self

File name creation, deletion, or rename.

pub const DIR_NAME: Self

Directory creation or deletion.

pub const ATTRIBUTES: Self

Attribute changes.

pub const SIZE: Self

Size changes, reported when the file is flushed rather than on write.

pub const LAST_WRITE: Self

Last-write-time changes, likewise reported on flush.

pub const LAST_ACCESS: Self

Last-access-time changes.

pub const CREATION: Self

Creation-time changes.

pub const SECURITY: Self

Security-descriptor changes.

pub const fn from_bits(bits: FILE_NOTIFY_CHANGE) -> Self

Wraps a raw FILE_NOTIFY_CHANGE mask.

Any bit pattern is accepted: the crate does not decide which bits Windows understands.

pub const fn bits(self) -> FILE_NOTIFY_CHANGE

The raw mask.

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

The union of two filters.

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

Whether every bit of other is set in this filter.

Trait Implementations

impl BitOr for NotifyFilter

type Output = NotifyFilter

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for NotifyFilter

fn clone(&self) -> NotifyFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NotifyFilter

impl Debug for NotifyFilter

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

Formats the value using the given formatter.

impl Default for NotifyFilter

fn default() -> NotifyFilter

Returns the “default value” for a type.

impl Display for NotifyFilter

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

Formats the value using the given formatter.

impl Eq for NotifyFilter

impl Hash for NotifyFilter

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 PartialEq for NotifyFilter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NotifyFilter