Struct undname::Flags

source ·
pub struct Flags(/* private fields */);
Expand description

Flags control how types are printed during demangling. See each flag for more info on what exactly they do.

Implementations§

source§

impl Flags

source

pub const NO_CALLING_CONVENTION: Self = _

Suppress calling conventions (__cdecl/__fastcall/__thiscall) from being included in the output.

use undname::Flags;
let input = "?func@MyClass@@UEAAHHH@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_CALLING_CONVENTION).unwrap();
assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
assert_eq!(with_flag,    "public: virtual int MyClass::func(int, int)");
source

pub const NO_ALLOCATION_LANGUAGE: Self = _

source

pub const NO_TAG_SPECIFIER: Self = _

Suppress tag specifiers (class/struct/union) from being included in the output.

use undname::Flags;
let input = "?x@@3PEAVty@@EA";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_TAG_SPECIFIER).unwrap();
assert_eq!(without_flag, "class ty *x");
assert_eq!(with_flag,    "ty *x");
source

pub const NO_ECSU: Self = _

See also NO_TAG_SPECIFIER.

source

pub const NO_ACCESS_SPECIFIER: Self = _

Suppress access specifiers (private/public/protected) from being included in the output.

use undname::Flags;
let input = "?func@MyClass@@UEAAHHH@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_ACCESS_SPECIFIER).unwrap();
assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
assert_eq!(with_flag,    "virtual int __cdecl MyClass::func(int, int)");
source

pub const NO_ACCESS_SPECIFIERS: Self = _

source

pub const NO_MEMBER_TYPE: Self = _

Suppress member types (static/virtual/extern "C") from being included in the output.

use undname::Flags;
let input = "?func@MyClass@@UEAAHHH@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_MEMBER_TYPE).unwrap();
assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
assert_eq!(with_flag,    "public: int __cdecl MyClass::func(int, int)");
source

pub const NO_RETURN_TYPE: Self = _

Suppress return types from being included in the output.

use undname::Flags;
let input = "?func@MyClass@@UEAAHHH@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_RETURN_TYPE).unwrap();
assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
assert_eq!(with_flag,    "public: virtual __cdecl MyClass::func(int, int)");
source

pub const NO_FUNCTION_RETURNS: Self = _

See also NO_RETURN_TYPE.

source

pub const NO_VARIABLE_TYPE: Self = _

Suppress variable types from being included in the output.

use undname::Flags;
let input = "?x@@3PEAEEA";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_VARIABLE_TYPE).unwrap();
assert_eq!(without_flag, "unsigned char *x");
assert_eq!(with_flag,    "x");
source

pub const NO_THISTYPE: Self = _

Suppress modifiers on the this type (const/volatile/__restrict) from being included in the output.

use undname::Flags;
let input = "?world@hello@@QEDAXXZ";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_THISTYPE).unwrap();
assert_eq!(without_flag, "public: void __cdecl hello::world(void) const volatile");
assert_eq!(with_flag,    "public: void __cdecl hello::world(void)");
source

pub const NO_LEADING_UNDERSCORES: Self = _

Suppress leading underscores on Microsoft extended keywords (__restrict/__cdecl/__fastcall) from being included in the output.

use undname::Flags;
let input = "?foo_piad@@YAXPIAD@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_LEADING_UNDERSCORES).unwrap();
assert_eq!(without_flag, "void __cdecl foo_piad(char *__restrict)");
assert_eq!(with_flag,    "void cdecl foo_piad(char *restrict)");
source

pub const NO_MS_KEYWORDS: Self = _

Suppress Microsoft keywords (__restrict/__unaligned/__cdecl) from being included in the output.

use undname::Flags;
let input = "?f@@YAXPEIFAH@Z";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NO_MS_KEYWORDS).unwrap();
assert_eq!(without_flag, "void __cdecl f(int __unaligned *__restrict)");
assert_eq!(with_flag,    "void f(int *)");
source

pub const NAME_ONLY: Self = _

Output only the name for the primary declaration.

use undname::Flags;
let input = "?world@hello@@QEDAXXZ";
let without_flag = undname::demangle(input, Flags::default()).unwrap();
let with_flag = undname::demangle(input, Flags::NAME_ONLY).unwrap();
assert_eq!(without_flag, "public: void __cdecl hello::world(void) const volatile");
assert_eq!(with_flag,    "hello::world");
source§

impl Flags

source

pub const fn empty() -> Self

Get a flags value with all bits unset.

source

pub const fn all() -> Self

Get a flags value with all known bits set.

source

pub const fn bits(&self) -> u16

Get the underlying bits value.

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

source

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.

source

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

Convert from a bits value, unsetting any unknown bits.

source

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

Convert from a bits value exactly.

source

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.

source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

source

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.

source

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.

source

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

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

source

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.

source

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

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

source

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

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

source

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

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

source

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

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

source

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.

source

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

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

source

pub const fn complement(self) -> Self

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

source§

impl Flags

source

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

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.

source

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

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§

source§

impl Binary for Flags

source§

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

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

impl BitAnd for Flags

source§

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

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

§

type Output = Flags

The resulting type after applying the & operator.
source§

impl BitAndAssign for Flags

source§

fn bitand_assign(&mut self, other: Self)

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

source§

impl BitOr for Flags

source§

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

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

§

type Output = Flags

The resulting type after applying the | operator.
source§

impl BitOrAssign for Flags

source§

fn bitor_assign(&mut self, other: Self)

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

source§

impl BitXor for Flags

source§

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

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

§

type Output = Flags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Flags

source§

fn bitxor_assign(&mut self, other: Self)

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

source§

impl Clone for Flags

source§

fn clone(&self) -> Flags

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Flags

source§

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

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

impl Default for Flags

source§

fn default() -> Flags

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

impl Extend<Flags> for Flags

source§

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

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

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl Flags for Flags

source§

const FLAGS: &'static [Flag<Flags>] = _

The set of defined flags.
§

type Bits = u16

The underlying bits type.
source§

fn bits(&self) -> u16

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u16) -> Flags

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 from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
§

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. Read more
§

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

Yield a set of contained flags values. Read more
§

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

Yield a set of contained named flags values. Read more
§

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 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 (&!). Read more
§

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 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 (&!). Read more
§

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.
source§

impl FromIterator<Flags> for Flags

source§

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

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

source§

impl Hash for Flags

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

§

type Item = Flags

The type of the elements being iterated over.
§

type IntoIter = Iter<Flags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Flags

source§

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

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

impl Not for Flags

source§

fn not(self) -> Self

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

§

type Output = Flags

The resulting type after applying the ! operator.
source§

impl Octal for Flags

source§

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

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

impl PartialEq for Flags

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for Flags

§

type Primitive = u16

The type of the underlying storage.
§

type Internal = InternalBitFlags

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

impl Sub for Flags

source§

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 = Flags

The resulting type after applying the - operator.
source§

impl SubAssign for Flags

source§

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.

source§

impl UpperHex for Flags

source§

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

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

impl Copy for Flags

source§

impl Eq for Flags

source§

impl StructuralPartialEq for Flags

Auto Trait Implementations§

§

impl Freeze for Flags

§

impl RefUnwindSafe for Flags

§

impl Send for Flags

§

impl Sync for Flags

§

impl Unpin for Flags

§

impl UnwindSafe for Flags

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: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.