Skip to main content

FinalPathFlags

Struct FinalPathFlags 

Source
pub struct FinalPathFlags(/* private fields */);
Expand description

Which form of the final path to report.

A newtype over the flags rather than an enum, because the value combines a volume-name choice with a path-form choice and Windows may define more.

§Example

use windows_namespace_request_sys::final_path::FinalPathFlags;

// What the watcher uses, and the default here.
let default = FinalPathFlags::DEFAULT;
assert_eq!(default, FinalPathFlags::VOLUME_NAME_DOS | FinalPathFlags::NAME_NORMALIZED);

// VOLUME_NAME_DOS and FILE_NAME_NORMALIZED are both zero: they are the
// defaults Windows applies when no opposing bit is set, not flags that can
// be observed as present.
assert_eq!(default.bits(), 0);

// The alternatives are the ones that carry bits.
assert_ne!(FinalPathFlags::VOLUME_NAME_GUID.bits(), 0);

Implementations§

Source§

impl FinalPathFlags

Source

pub const VOLUME_NAME_DOS: Self

A drive letter, if the volume has one. Windows’ default.

Source

pub const VOLUME_NAME_GUID: Self

A volume GUID path, which has no dependence on drive-letter mappings.

Source

pub const VOLUME_NAME_NT: Self

The NT device path.

Source

pub const VOLUME_NAME_NONE: Self

No volume component at all.

Source

pub const NAME_NORMALIZED: Self

The normalised form of the path. Windows’ default.

Source

pub const NAME_OPENED: Self

The path as it was opened, which may not be normalised.

Source

pub const DEFAULT: Self

VOLUME_NAME_DOS | FILE_NAME_NORMALIZED, which is what the audited watcher relies on.

Source

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

Wraps a raw flags value.

Source

pub const fn bits(self) -> GETFINALPATHNAMEBYHANDLE_FLAGS

The raw flags value.

Trait Implementations§

Source§

impl BitOr for FinalPathFlags

Source§

type Output = FinalPathFlags

The resulting type after applying the | operator.
Source§

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

Performs the | operation. Read more
Source§

impl Clone for FinalPathFlags

Source§

fn clone(&self) -> FinalPathFlags

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FinalPathFlags

Source§

impl Debug for FinalPathFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FinalPathFlags

Source§

fn default() -> FinalPathFlags

Returns the “default value” for a type. Read more
Source§

impl Eq for FinalPathFlags

Source§

impl Hash for FinalPathFlags

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FinalPathFlags

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FinalPathFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.