Struct EnumerationRequest 

pub struct EnumerationRequest { /* private fields */ }

One directory to enumerate, with the predicate and bounds that apply to it.

Implementations

impl EnumerationRequest

pub fn new(path: &Wtf16Str) -> Result<Self, RequestError>

Build a request for a native WTF-16 path.

The path is validated and, unless it is already a verbatim \\?\ path, resolved to its fully qualified form now. The stored value is exactly what a worker will later open.

Errors

Returns RequestError for an empty path, an interior NUL, a \\?\ path that is not fully qualified, an ordinary path longer than MAX_PATH before or after resolution, or a resolution failure reported by Windows.

pub fn for_path(path: &Path) -> Result<Self, RequestError>

Build a request for a std path.

The conversion is lossless in both directions: a Windows Path is already WTF-16 underneath.

Errors

As new.

pub fn with_predicate(self, predicate: impl Into<EntryPredicate>) -> Self

Set the predicate entries must satisfy to be delivered.

Infallible because a QueryByExample validates each clause as it is added, so an invalid predicate cannot be built in the first place.

pub fn with_file_identity(self, mode: FileIdentityMode) -> Self

Set how much work the request will do for file identity.

pub fn with_buffer_capacity(self, bytes: usize) -> Result<Self, RequestError>

Set the native buffer capacity, in bytes.

The value is clamped up to MINIMUM_BUFFER_CAPACITY and then rounded up to the record alignment. The result is fixed for the request’s whole life: the buffer never grows in response to what a directory turns out to contain, because a bound that silently moves is not a bound. Read the value back with buffer_capacity.

Errors

Returns RequestFailure::BufferCapacityUnrepresentable if the aligned capacity cannot be passed to Win32 as a u32.

pub fn path(&self) -> &Wtf16Str

The exact path a worker will open.

pub fn predicate(&self) -> &EntryPredicate

The predicate entries must satisfy.

pub fn file_identity_mode(&self) -> FileIdentityMode

How much work the request will do for file identity.

pub fn buffer_capacity(&self) -> usize

The effective native buffer capacity, in bytes, after clamping and alignment.

Trait Implementations

impl Clone for EnumerationRequest

fn clone(&self) -> EnumerationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumerationRequest

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

Formats the value using the given formatter.

impl Eq for EnumerationRequest

impl PartialEq for EnumerationRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EnumerationRequest