Struct lnk::LinkFlags

pub struct LinkFlags { /* fields omitted */ }

The LinkFlags structure defines bits that specify which shell linkstructures are present in the file format after the ShellLinkHeaderstructure (section 2.1).

Implementations

impl LinkFlags

pub const HAS_LINK_TARGET_ID_LIST: LinkFlags

The shell link is saved with an item ID list (IDList). If this bit is set, a LinkTargetIDList structure (section 2.2) MUST follow the ShellLinkHeader. If this bit is not set, this structure MUST NOT be present.

pub const HAS_LINK_INFO: LinkFlags

The shell link is saved with link information. If this bit is set, a LinkInfo structure (section 2.3) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const HAS_NAME: LinkFlags

The shell link is saved with a name string. If this bit is set, a NAME_STRING StringData structure (section 2.4) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const HAS_RELATIVE_PATH: LinkFlags

The shell link is saved with a relative path string. If this bit is set, a RELATIVE_PATH StringData structure (section 2.4) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const HAS_WORKING_DIR: LinkFlags

The shell link is saved with a relative path string. If this bit is set, a WORKING_DIR StringData structure (section 2.4) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const HAS_ARGUMENTS: LinkFlags

The shell link is saved with a relative path string. If this bit is set, a COMMAND_LINE_ARGUMENTS StringData structure (section 2.4) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const HAS_ICON_LOCATION: LinkFlags

The shell link is saved with a relative path string. If this bit is set, a ICON_LOCATION StringData structure (section 2.4) MUST be present. If this bit is not set, this structure MUST NOT be present.

pub const IS_UNICODE: LinkFlags

The shell link contains Unicode encoded strings. This bit SHOULD be set. If this bit is set, the StringData section contains Unicode-encoded strings; otherwise, it contains strings that are encoded using the system default code page

pub const FORCE_NO_LINK_INFO: LinkFlags

The LinkInfo structure (section 2.3) is ignored.

pub const HAS_EXP_STRING: LinkFlags

The shell link is saved with an EnvironmentVariableDataBlock (section 2.5.4).

pub const RUN_IN_SEPARATE_PROCESS: LinkFlags

The target is run in a separate virtual machine when launching a link target that is a 16-bit application.

pub const UNUSED1: LinkFlags

A bit that is undefined and MUST be ignored.

pub const HAS_DARWIN_ID: LinkFlags

The shell link is saved with a DarwinDataBlock(section2.5.3).

pub const RUN_AS_USER: LinkFlags

The application is run as a different user when the target of the shell link is activated.

pub const HAS_EXP_ICON: LinkFlags

The shell link is saved with an IconEnvironmentDataBlock (section 2.5.5).

pub const NO_PIDL_ALIAS: LinkFlags

The file system location is represented in the shell namespace when the path to an item is parsed into an IDList.

pub const UNUSED2: LinkFlags

A bit that is undefined and MUST be ignored.

pub const RUN_WITH_SHIM_LAYER: LinkFlags

The shell link is saved with a ShimDataBlock(section2.5.8)

pub const FORCE_NO_LINK_TRACK: LinkFlags

The TrackerDataBlock(section2.5.10)is ignored.

pub const ENABLE_TARGET_METADATA: LinkFlags

The shell link attempts to collect target properties and store them in the PropertyStoreDataBlock(section2.5.7) when the link target is set.

pub const DISABLE_LINK_PATH_TRACKING: LinkFlags

The EnvironmentVariableDataBlock is ignored.

pub const DISABLE_KNOWN_FOLDER_TRACKING: LinkFlags

The SpecialFolderDataBlock(section2.5.9)and the KnownFolderDataBlock(section2.5.6)are ignored when loading the shell link. If this bit is set, these extra data blocks SHOULD NOT be saved when saving the shell link.

pub const DISABLE_KNOWN_FOLDER_ALIAS: LinkFlags

If the linkhas a KnownFolderDataBlock(section2.5.6), the unaliased form of the known folder IDList SHOULD be used when translating the target IDList at the time that the link is loaded.

pub const ALLOW_LINK_TO_LINK: LinkFlags

Creating a link that references another link is enabled. Otherwise, specifying a link as the target IDList SHOULD NOT be allowed.

pub const UNALIAS_ON_SAVE: LinkFlags

When saving a link for which the target IDList is under a known folder, either the unaliased form of that known folder or the target IDList SHOULD be used.

pub const PREFER_ENVIRONMENT_PATH: LinkFlags

The target IDList SHOULD NOT be stored; instead, the path specified in the EnvironmentVariableDataBlock(section2.5.4) SHOULD be used to refer to the target.

pub const KEEP_LOCAL_ID_LIST_FOR_UNC_TARGET: LinkFlags

When the target is a UNC name that refers to a location on a local machine, the local path IDList in the PropertyStoreDataBlock(section2.5.7) SHOULD be stored, so it can be used when the link is loaded on the local machine.

pub const fn empty() -> LinkFlags

Returns an empty set of flags

pub const fn all() -> LinkFlags

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for LinkFlags

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

Formats the value using the given formatter.

impl BitAnd<LinkFlags> for LinkFlags

type Output = LinkFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<LinkFlags> for LinkFlags

fn bitand_assign(&mut self, other: LinkFlags)

Disables all flags disabled in the set.

impl BitOr<LinkFlags> for LinkFlags

type Output = LinkFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<LinkFlags> for LinkFlags

fn bitor_assign(&mut self, other: LinkFlags)

Adds the set of flags.

impl BitXor<LinkFlags> for LinkFlags

type Output = LinkFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<LinkFlags> for LinkFlags

fn bitxor_assign(&mut self, other: LinkFlags)

Toggles the set of flags.

impl Clone for LinkFlags

fn clone(&self) -> LinkFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LinkFlags

impl Debug for LinkFlags

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

Formats the value using the given formatter.

impl Eq for LinkFlags

impl Extend<LinkFlags> for LinkFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<LinkFlags> for LinkFlags

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

Creates a value from an iterator.

impl Hash for LinkFlags

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 LinkFlags

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

Formats the value using the given formatter.

impl Not for LinkFlags

type Output = LinkFlags

The resulting type after applying the ! operator.

fn not(self) -> LinkFlags

Returns the complement of this set of flags.

impl Octal for LinkFlags

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

Formats the value using the given formatter.

impl Ord for LinkFlags

fn cmp(&self, other: &LinkFlags) -> 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<LinkFlags> for LinkFlags

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

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

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

This method tests for !=.

impl PartialOrd<LinkFlags> for LinkFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for LinkFlags

impl StructuralPartialEq for LinkFlags

impl Sub<LinkFlags> for LinkFlags

type Output = LinkFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<LinkFlags> for LinkFlags

fn sub_assign(&mut self, other: LinkFlags)

Disables all flags enabled in the set.

impl UpperHex for LinkFlags

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

Formats the value using the given formatter.