Struct dokan::MountFlags

pub struct MountFlags { /* fields omitted */ }

Flags that control behavior of the mounted volume.

Implementations

impl MountFlags

pub const DEBUG: MountFlags

Enable debug message output.

pub const STDERR: MountFlags

Write debug messages to stderr.

pub const ALT_STREAM: MountFlags

Enable support for alternative streams.

The driver will fail any attempts to access a path with a colon (:).

pub const WRITE_PROTECT: MountFlags

Make the mounted volume write-protected (i.e. read-only).

pub const NETWORK: MountFlags

Mount as a network drive.

Dokan network provider must be installed for this to work.

pub const REMOVABLE: MountFlags

Mount as a removable device.

pub const MOUNT_MANAGER: MountFlags

Use Mount Manager to mount the volume.

pub const CURRENT_SESSION: MountFlags

Mount the volume on current session only.

pub const FILELOCK_USER_MODE: MountFlags

Use FileSystemHandler::lock_file and FileSystemHandler::unlock_file to handle file locking.

Dokan will take care of file locking if this flags is not present.

pub const ENABLE_NOTIFICATION_API: MountFlags

Enable notification API support.

Notification functions like notify_create require this flag to be present, otherwise they will always fail and return false.

pub const ENABLE_FCB_GARBAGE_COLLECTION: MountFlags

Enable garbage collection of file control blocks (FCB).

It prevents filter drivers (like anti-virus software) from exponentially slowing down certain operations due to repeatedly rebuilding state that they attach to the FCB header.

pub const CASE_SENSITIVE: MountFlags

Enable case-sensitive file names.

pub const ENABLE_UNOUNT_NETWORK_DRIVE: MountFlags

Allow unmounting network drives from Windows Explorer.

pub const DISPATCH_DRIVER_LOGS: MountFlags

Forward the kernel driver global and volume logs to the userland.

pub const fn empty() -> MountFlags

Returns an empty set of flags

pub const fn all() -> MountFlags

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<MountFlags>

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for MountFlags

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

Formats the value using the given formatter.

impl BitAnd<MountFlags> for MountFlags

type Output = MountFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<MountFlags> for MountFlags

fn bitand_assign(&mut self, other: MountFlags)

Disables all flags disabled in the set.

impl BitOr<MountFlags> for MountFlags

type Output = MountFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<MountFlags> for MountFlags

fn bitor_assign(&mut self, other: MountFlags)

Adds the set of flags.

impl BitXor<MountFlags> for MountFlags

type Output = MountFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<MountFlags> for MountFlags

fn bitxor_assign(&mut self, other: MountFlags)

Toggles the set of flags.

impl Clone for MountFlags

fn clone(&self) -> MountFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MountFlags

impl Debug for MountFlags

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

Formats the value using the given formatter.

impl Eq for MountFlags

impl Extend<MountFlags> for MountFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<MountFlags> for MountFlags

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

Creates a value from an iterator.

impl Hash for MountFlags

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

Feeds this value into the given Hasher.

pub 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 MountFlags

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

Formats the value using the given formatter.

impl Not for MountFlags

type Output = MountFlags

The resulting type after applying the ! operator.

fn not(self) -> MountFlags

Returns the complement of this set of flags.

impl Octal for MountFlags

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

Formats the value using the given formatter.

impl Ord for MountFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<MountFlags> for MountFlags

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

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

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

This method tests for !=.

impl PartialOrd<MountFlags> for MountFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for MountFlags

impl StructuralPartialEq for MountFlags

impl Sub<MountFlags> for MountFlags

type Output = MountFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<MountFlags> for MountFlags

fn sub_assign(&mut self, other: MountFlags)

Disables all flags enabled in the set.

impl UpperHex for MountFlags

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

Formats the value using the given formatter.