Struct iced_x86::UsedMemory

pub struct UsedMemory { /* fields omitted */ }

A memory location used by an instruction

Implementations

impl UsedMemory

#[must_use]

pub fn new(
    segment: Register,
    base: Register,
    index: Register,
    scale: u32,
    displacement: u64,
    memory_size: MemorySize,
    access: OpAccess
) -> Self

Creates a new instance

Arguments

• segment: Effective segment register or Register::None if the segment register is ignored
• base: Base register
• index: Index register
• scale: 1, 2, 4 or 8
• displacement: Displacement
• memory_size: Memory size
• access: Access

#[must_use]

pub fn new2(
    segment: Register,
    base: Register,
    index: Register,
    scale: u32,
    displacement: u64,
    memory_size: MemorySize,
    access: OpAccess,
    address_size: CodeSize,
    vsib_size: u32
) -> Self

Creates a new instance

Arguments

• segment: Effective segment register or Register::None if the segment register is ignored
• base: Base register
• index: Index register
• scale: 1, 2, 4 or 8
• displacement: Displacement
• memory_size: Memory size
• access: Access
• address_size: Address size
• vsib_size: VSIB size (0, 4 or 8)

#[must_use]

pub fn segment(&self) -> Register

Effective segment register or Register::None if the segment register is ignored

#[must_use]

pub fn base(&self) -> Register

Base register or Register::None if none

#[must_use]

pub fn index(&self) -> Register

Index register or Register::None if none

#[must_use]

pub fn scale(&self) -> u32

Index scale (1, 2, 4 or 8)

#[must_use]

pub fn displacement(&self) -> u64

Displacement

#[must_use]

pub fn memory_size(&self) -> MemorySize

Size of location

#[must_use]

pub fn access(&self) -> OpAccess

Memory access

#[must_use]

pub fn address_size(&self) -> CodeSize

Address size

#[must_use]

pub fn vsib_size(&self) -> u32

VSIB size (0, 4 or 8)

#[must_use]

pub fn virtual_address<F>(
    &self,
    element_index: usize,
    get_register_value: F
) -> u64 where
    F: FnMut(Register, usize, usize) -> u64, 

👎 Deprecated since 1.11.0:

This method can panic, use try_virtual_address() instead

Gets the virtual address of a used memory location. See also try_virtual_address()

Panics

Panics if virtual address computation fails.

Arguments

• get_register_value: Function that returns the value of a register or the base address of a segment register.

Call-back function args

• Arg 1: register: Register. If it’s a segment register, the call-back should return the segment’s base address, not the segment’s register value.
• Arg 2: element_index: Only used if it’s a vsib memory operand. This is the element index of the vector index register.
• Arg 3: element_size: Only used if it’s a vsib memory operand. Size in bytes of elements in vector index register (4 or 8).

#[must_use]

pub fn try_virtual_address<F>(
    &self,
    element_index: usize,
    get_register_value: F
) -> Option<u64> where
    F: FnMut(Register, usize, usize) -> Option<u64>, 

Gets the virtual address of a used memory location, or None if register resolution fails.

Arguments

• get_register_value: Function that returns the value of a register or the base address of a segment register, or None on failure.

Call-back function args

• Arg 1: register: Register. If it’s a segment register, the call-back should return the segment’s base address, not the segment’s register value.
• Arg 2: element_index: Only used if it’s a vsib memory operand. This is the element index of the vector index register.
• Arg 3: element_size: Only used if it’s a vsib memory operand. Size in bytes of elements in vector index register (4 or 8).

Trait Implementations

impl Clone for UsedMemory

fn clone(&self) -> UsedMemory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UsedMemory

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

Formats the value using the given formatter.

impl Default for UsedMemory

fn default() -> UsedMemory

Returns the “default value” for a type.

impl Hash for UsedMemory

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 PartialEq<UsedMemory> for UsedMemory

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

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

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

This method tests for !=.

impl Copy for UsedMemory

impl Eq for UsedMemory

impl StructuralEq for UsedMemory

impl StructuralPartialEq for UsedMemory