Struct vtil_parser::RegisterFlags

pub struct RegisterFlags { /* fields omitted */ }

Flags describing register properties

Implementations

impl RegisterFlags

pub const VIRTUAL: RegisterFlags

Default value if no flags set. Read/write pure virtual register that is not a stack pointer or flags

pub const PHYSICAL: RegisterFlags

Indicates that the register is a physical register

pub const LOCAL: RegisterFlags

Indicates that the register is a local temporary register of the current basic block

pub const FLAGS: RegisterFlags

Indicates that the register is used to hold CPU flags

pub const STACK_POINTER: RegisterFlags

Indicates that the register is used as the stack pointer

pub const IMAGE_BASE: RegisterFlags

Indicates that the register is an alias to the image base

pub const VOLATILE: RegisterFlags

Indicates that the register can change spontanously (e.g.: IA32_TIME_STAMP_COUNTER)

pub const READONLY: RegisterFlags

Indicates that the register can change spontanously (e.g.: IA32_TIME_STAMP_COUNTER)

pub const UNDEFINED: RegisterFlags

Indicates that it is the special “undefined” register

pub const INTERNAL: RegisterFlags

Indicates that it is a internal-use register that should be treated like any other virtual register

pub const SPECIAL: RegisterFlags

Combined mask of all special registers

pub const fn empty() -> RegisterFlags

Returns an empty set of flags

pub const fn all() -> RegisterFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<RegisterFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u64) -> RegisterFlags

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> RegisterFlags

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for RegisterFlags

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

Formats the value using the given formatter.

impl BitAnd<RegisterFlags> for RegisterFlags

type Output = RegisterFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<RegisterFlags> for RegisterFlags

fn bitand_assign(&mut self, other: RegisterFlags)

Disables all flags disabled in the set.

impl BitOr<RegisterFlags> for RegisterFlags

type Output = RegisterFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<RegisterFlags> for RegisterFlags

fn bitor_assign(&mut self, other: RegisterFlags)

Adds the set of flags.

impl BitXor<RegisterFlags> for RegisterFlags

type Output = RegisterFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<RegisterFlags> for RegisterFlags

fn bitxor_assign(&mut self, other: RegisterFlags)

Toggles the set of flags.

impl Clone for RegisterFlags

fn clone(&self) -> RegisterFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RegisterFlags

impl Debug for RegisterFlags

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

Formats the value using the given formatter.

impl Eq for RegisterFlags

impl Extend<RegisterFlags> for RegisterFlags

fn extend<T: IntoIterator<Item = RegisterFlags>>(&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<RegisterFlags> for RegisterFlags

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

Creates a value from an iterator.

impl Hash for RegisterFlags

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 RegisterFlags

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

Formats the value using the given formatter.

impl Not for RegisterFlags

type Output = RegisterFlags

The resulting type after applying the ! operator.

fn not(self) -> RegisterFlags

Returns the complement of this set of flags.

impl Octal for RegisterFlags

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

Formats the value using the given formatter.

impl Ord for RegisterFlags

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

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

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

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

This method tests for !=.

impl PartialOrd<RegisterFlags> for RegisterFlags

fn partial_cmp(&self, other: &RegisterFlags) -> 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 RegisterFlags

impl StructuralPartialEq for RegisterFlags

impl Sub<RegisterFlags> for RegisterFlags

type Output = RegisterFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<RegisterFlags> for RegisterFlags

fn sub_assign(&mut self, other: RegisterFlags)

Disables all flags enabled in the set.

impl UpperHex for RegisterFlags

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

Formats the value using the given formatter.