Struct WatchDirectory 

pub struct WatchDirectory { /* private fields */ }

An owned, marshalable parameter set for FindFirstChangeNotificationW.

Example

use windows_namespace_request_sys::prepare;
use windows_namespace_request_sys::watch::{NotifyFilter, WatchDirectory};
use wtf_string::Wtf16String;

let directory = std::env::temp_dir();
let text = directory.to_str().expect("the temporary directory is valid UTF-8");

let request = WatchDirectory::new(prepare(&Wtf16String::from(text))?)
    .with_subtree(true)
    .with_filter(NotifyFilter::FILE_NAME | NotifyFilter::DIR_NAME);

let notification = request.perform()?;
// The handle is closed with FindCloseChangeNotification, which the type
// remembers on the caller's behalf.
drop(notification);

Implementations

impl WatchDirectory

pub fn new(path: PreparedPath) -> Self

Begins a request to watch path.

The watch starts non-recursive and watching for nothing; both are set explicitly, as everywhere else in this crate.

pub fn with_subtree(self, subtree: bool) -> Self

Sets bWatchSubtree.

pub fn with_filter(self, filter: NotifyFilter) -> Self

Sets dwNotifyFilter.

pub fn path(&self) -> &PreparedPath

The prepared path this request will watch.

pub fn subtree(&self) -> bool

Whether the watch covers the whole subtree.

pub fn filter(&self) -> NotifyFilter

The change classes the watch reports.

pub fn perform(&self) -> Outcome<ChangeNotification>

Performs the call on the calling thread.

Errors

Returns the raw Win32 code, unaltered.

Trait Implementations

impl Clone for WatchDirectory

fn clone(&self) -> WatchDirectory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchDirectory

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

Formats the value using the given formatter.

impl Request for WatchDirectory

type Error = Win32Error

How performing it can fail.

type Output = ChangeNotification

What performing the request produces.

fn perform(&self) -> Outcome<ChangeNotification>

Performs the request on the calling thread.