Struct Characteristics

pub struct Characteristics(/* private fields */);

The Characteristics field contains flags that indicate attributes of the object or image file.

Implementations

impl Characteristics

pub const IMAGE_FILE_RELOCS_STRIPPED: Self

Image only, Windows CE, and Microsoft Windows NT and later. This indicates that the file does not contain base relocations and must therefore be loaded at its preferred base address. If the base address is not available, the loader reports an error. The default behavior of the linker is to strip base relocations from executable (EXE) files.

pub const IMAGE_FILE_EXECUTABLE_IMAGE: Self

Image only. This indicates that the image file is valid and can be run. If this flag is not set, it indicates a linker error.

pub const IMAGE_FILE_LINE_NUMS_STRIPPED: Self

COFF line numbers have been removed. This flag is deprecated and should be zero.

pub const IMAGE_FILE_LOCAL_SYMS_STRIPPED: Self

COFF symbol table entries for local symbols have been removed. This flag is deprecated and should be zero.

pub const IMAGE_FILE_AGGRESIVE_WS_TRIM: Self

Obsolete. Aggressively trim working set. This flag is deprecated for Windows 2000 and later and must be zero.

pub const IMAGE_FILE_LARGE_ADDRESS_AWARE: Self

Application can handle > 2-GB addresses.

pub const IMAGE_FILE_RESERVED1: Self

This flag is reserved for future use.

pub const IMAGE_FILE_BYTES_RESERVED_LO: Self

Little endian: the least significant bit (LSB) precedes the most significant bit (MSB) in memory. This flag is deprecated and should be zero.

pub const IMAGE_FILE_32BIT_MACHINE: Self

Machine is based on a 32-bit-word architecture.

pub const IMAGE_FILE_DEBUG_STRIPPED: Self

Debugging information is removed from the image file.

pub const IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP: Self

If the image is on removable media, fully load it and copy it to the swap file.

pub const IMAGE_FILE_NET_RUN_FROM_SWAP: Self

If the image is on network media, fully load it and copy it to the swap file.

pub const IMAGE_FILE_SYSTEM: Self

The image file is a system file, not a user program.

pub const IMAGE_FILE_DLL: Self

The image file is a dynamic-link library (DLL). Such files are considered executable files for almost all purposes, although they cannot be directly run.

pub const IMAGE_FILE_UP_SYSTEM_ONLY: Self

The file should be run only on a uniprocessor machine.

pub const IMAGE_FILE_BYTES_RESERVED_HI: Self

Big endian: the MSB precedes the LSB in memory. This flag is deprecated and should be zero.

impl Characteristics

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Characteristics

pub const fn iter(&self) -> Iter<Characteristics>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Characteristics>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for Characteristics

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

Formats the value using the given formatter.

impl BitAnd for Characteristics

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

The bitwise and (&) of the bits in two flags values.

type Output = Characteristics

The resulting type after applying the & operator.

impl BitAndAssign for Characteristics

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Characteristics

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

The bitwise or (|) of the bits in two flags values.

type Output = Characteristics

The resulting type after applying the | operator.

impl BitOrAssign for Characteristics

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Characteristics

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Characteristics

The resulting type after applying the ^ operator.

impl BitXorAssign for Characteristics

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Debug for Characteristics

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

Formats the value using the given formatter.

impl Display for Characteristics

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

Formats the value using the given formatter.

impl Extend<Characteristics> for Characteristics

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

The bitwise or (|) of the bits in each flags value.

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 Flags for Characteristics

const FLAGS: &'static [Flag<Characteristics>]

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> Characteristics

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Characteristics> for Characteristics

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

The bitwise or (|) of the bits in each flags value.

impl FromStr for Characteristics

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(flags: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoIterator for Characteristics

type Item = Characteristics

The type of the elements being iterated over.

type IntoIter = Iter<Characteristics>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Characteristics

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

Formats the value using the given formatter.

impl Not for Characteristics

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Characteristics

The resulting type after applying the ! operator.

impl Octal for Characteristics

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

Formats the value using the given formatter.

impl PublicFlags for Characteristics

type Primitive = u16

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for Characteristics

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Characteristics

The resulting type after applying the - operator.

impl SubAssign for Characteristics

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Characteristics

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

Formats the value using the given formatter.