Struct lnk::FileAttributeFlags

pub struct FileAttributeFlags { /* fields omitted */ }

The FileAttributesFlags structure defines bits that specify the file attributes of the link target, if the target is a file system item. File attributes can be used if the link target is not available, or if accessing the target would be inefficient. It is possible for the target items attributes to be out of sync with this value.

Methods

impl FileAttributeFlags

pub const FILE_ATTRIBUTE_READONLY: FileAttributeFlags

The file or directory is read-only. For a file, if this bit is set, applications can read the file but cannot write to it or delete it. For a directory, if this bit is set, applications cannot delete the directory

pub const FILE_ATTRIBUTE_HIDDEN: FileAttributeFlags

The file or directory is hidden. If this bit is set, the file or folder is not included in an ordinary directory listing.

pub const FILE_ATTRIBUTE_SYSTEM: FileAttributeFlags

The file or directory is part of the operating system or is used exclusively by the operating system.

pub const RESERVED1: FileAttributeFlags

A bit that MUST be zero.

pub const FILE_ATTRIBUTE_DIRECTORY: FileAttributeFlags

The link target is a directory instead of a file.

pub const FILE_ATTRIBUTE_ARCHIVE: FileAttributeFlags

The file or directory is an archive file. Applications use this flag to mark files for backup or removal.

pub const RESERVED2: FileAttributeFlags

A bit that MUST be zero.

pub const FILE_ATTRIBUTE_NORMAL: FileAttributeFlags

The file or directory has no other flags set. If this bit is 1, all other bits in this structure MUST be clear.

pub const FILE_ATTRIBUTE_TEMPORARY: FileAttributeFlags

The file is being used for temporary storage.

pub const FILE_ATTRIBUTE_SPARSE_FILE: FileAttributeFlags

The file is a sparse file.

pub const FILE_ATTRIBUTE_REPARSE_POINT: FileAttributeFlags

The file or directory has an associated reparse point.

pub const FILE_ATTRIBUTE_COMPRESSED: FileAttributeFlags

The file or directory is compressed. For a file, this means that all data in the file is compressed. For a directory, this means that compression is the default for newly created files and subdirectories.

pub const FILE_ATTRIBUTE_OFFLINE: FileAttributeFlags

The data of the file is not immediately available.

pub const FILE_ATTRIBUTE_NOT_CONTENT_INDEXED: FileAttributeFlags

The contents of the file need to be indexed.

pub const FILE_ATTRIBUTE_ENCRYPTED: FileAttributeFlags

The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and subdirectories.

pub const fn empty() -> FileAttributeFlags

Returns an empty set of flags

pub const fn all() -> FileAttributeFlags

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for FileAttributeFlags

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

Formats the value using the given formatter.

impl BitAnd<FileAttributeFlags> for FileAttributeFlags

type Output = FileAttributeFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<FileAttributeFlags> for FileAttributeFlags

fn bitand_assign(&mut self, other: FileAttributeFlags)

Disables all flags disabled in the set.

impl BitOr<FileAttributeFlags> for FileAttributeFlags

type Output = FileAttributeFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<FileAttributeFlags> for FileAttributeFlags

fn bitor_assign(&mut self, other: FileAttributeFlags)

Adds the set of flags.

impl BitXor<FileAttributeFlags> for FileAttributeFlags

type Output = FileAttributeFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<FileAttributeFlags> for FileAttributeFlags

fn bitxor_assign(&mut self, other: FileAttributeFlags)

Toggles the set of flags.

impl Clone for FileAttributeFlags

fn clone(&self) -> FileAttributeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FileAttributeFlags

impl Debug for FileAttributeFlags

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

Formats the value using the given formatter.

impl Eq for FileAttributeFlags

impl Extend<FileAttributeFlags> for FileAttributeFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<FileAttributeFlags> for FileAttributeFlags

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

Creates a value from an iterator.

impl Hash for FileAttributeFlags

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for FileAttributeFlags

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

Formats the value using the given formatter.

impl Not for FileAttributeFlags

type Output = FileAttributeFlags

The resulting type after applying the ! operator.

fn not(self) -> FileAttributeFlags

Returns the complement of this set of flags.

impl Octal for FileAttributeFlags

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

Formats the value using the given formatter.

impl Ord for FileAttributeFlags

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<FileAttributeFlags> for FileAttributeFlags

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

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

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

This method tests for !=.

impl PartialOrd<FileAttributeFlags> for FileAttributeFlags

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

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

fn lt(&self, other: &FileAttributeFlags) -> bool

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

fn le(&self, other: &FileAttributeFlags) -> bool

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

fn gt(&self, other: &FileAttributeFlags) -> bool

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

fn ge(&self, other: &FileAttributeFlags) -> bool

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

impl StructuralEq for FileAttributeFlags

impl StructuralPartialEq for FileAttributeFlags

impl Sub<FileAttributeFlags> for FileAttributeFlags

type Output = FileAttributeFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<FileAttributeFlags> for FileAttributeFlags

fn sub_assign(&mut self, other: FileAttributeFlags)

Disables all flags enabled in the set.

impl UpperHex for FileAttributeFlags

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

Formats the value using the given formatter.