Struct iced_x86::RegisterInfo

pub struct RegisterInfo { /* private fields */ }

Register information

Implementations

impl RegisterInfo

pub const fn register(&self) -> Register

Gets the register

Examples

use iced_x86::*;
let info = Register::EAX.info();
assert_eq!(info.register(), Register::EAX);

pub const fn base(&self) -> Register

Gets the base register, eg. AL, AX, EAX, RAX, MM0, XMM0, YMM0, ZMM0, ES

Examples

use iced_x86::*;
let info = Register::GS.info();
assert_eq!(info.base(), Register::ES);
let info = Register::RDX.info();
assert_eq!(info.base(), Register::RAX);
let info = Register::XMM13.info();
assert_eq!(info.base(), Register::XMM0);
let info = Register::YMM13.info();
assert_eq!(info.base(), Register::YMM0);
let info = Register::ZMM13.info();
assert_eq!(info.base(), Register::ZMM0);

pub const fn number(&self) -> usize

The register number (index) relative to base(), eg. 0-15, or 0-31, or if 8-bit GPR, 0-19

Examples

use iced_x86::*;
let info = Register::GS.info();
assert_eq!(info.number(), 5);
let info = Register::RDX.info();
assert_eq!(info.number(), 2);
let info = Register::XMM13.info();
assert_eq!(info.number(), 13);
let info = Register::YMM13.info();
assert_eq!(info.number(), 13);
let info = Register::ZMM13.info();
assert_eq!(info.number(), 13);

pub const fn full_register(&self) -> Register

The full register that this one is a part of, eg. CL/CH/CX/ECX/RCX -> RCX, XMM11/YMM11/ZMM11 -> ZMM11

Examples

use iced_x86::*;
let info = Register::GS.info();
assert_eq!(info.full_register(), Register::GS);
let info = Register::BH.info();
assert_eq!(info.full_register(), Register::RBX);
let info = Register::DX.info();
assert_eq!(info.full_register(), Register::RDX);
let info = Register::ESP.info();
assert_eq!(info.full_register(), Register::RSP);
let info = Register::RCX.info();
assert_eq!(info.full_register(), Register::RCX);
let info = Register::XMM3.info();
assert_eq!(info.full_register(), Register::ZMM3);
let info = Register::YMM3.info();
assert_eq!(info.full_register(), Register::ZMM3);
let info = Register::ZMM3.info();
assert_eq!(info.full_register(), Register::ZMM3);

pub const fn full_register32(&self) -> Register

Gets the full register that this one is a part of, except if it’s a GPR in which case the 32-bit register is returned, eg. CL/CH/CX/ECX/RCX -> ECX, XMM11/YMM11/ZMM11 -> ZMM11

Examples

use iced_x86::*;
let info = Register::GS.info();
assert_eq!(info.full_register32(), Register::GS);
let info = Register::BH.info();
assert_eq!(info.full_register32(), Register::EBX);
let info = Register::DX.info();
assert_eq!(info.full_register32(), Register::EDX);
let info = Register::ESP.info();
assert_eq!(info.full_register32(), Register::ESP);
let info = Register::RCX.info();
assert_eq!(info.full_register32(), Register::ECX);
let info = Register::XMM3.info();
assert_eq!(info.full_register32(), Register::ZMM3);
let info = Register::YMM3.info();
assert_eq!(info.full_register32(), Register::ZMM3);
let info = Register::ZMM3.info();
assert_eq!(info.full_register32(), Register::ZMM3);

pub const fn size(&self) -> usize

Size of the register in bytes

Examples

use iced_x86::*;
let info = Register::GS.info();
assert_eq!(info.size(), 2);
let info = Register::BH.info();
assert_eq!(info.size(), 1);
let info = Register::DX.info();
assert_eq!(info.size(), 2);
let info = Register::ESP.info();
assert_eq!(info.size(), 4);
let info = Register::RCX.info();
assert_eq!(info.size(), 8);
let info = Register::XMM3.info();
assert_eq!(info.size(), 16);
let info = Register::YMM3.info();
assert_eq!(info.size(), 32);
let info = Register::ZMM3.info();
assert_eq!(info.size(), 64);

Trait Implementations

impl Clone for RegisterInfo

fn clone(&self) -> RegisterInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterInfo

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

Formats the value using the given formatter.

impl Hash for RegisterInfo

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RegisterInfo

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

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

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.

impl Copy for RegisterInfo

impl Eq for RegisterInfo

impl StructuralEq for RegisterInfo

impl StructuralPartialEq for RegisterInfo