Enum yaxpeax_x86::long_mode::InnerDescription

pub enum InnerDescription {
    RexPrefix(u8),
    SegmentPrefix(Segment),
    Opcode(Opcode),
    OperandCode(OperandCodeWrapper),
    RegisterNumber(&'static str, u8, RegSpec),
    Misc(&'static str),
    Number(&'static str, i64),
    Boundary(&'static str),
}

the actual description for a selection of bits involved in decoding an [long_mode::Instruction].

some prefixes are only identified as an InnerDescription::Misc string, while some are full InnerDescription::SegmentPrefix(Segment). generally, strings should be considered unstable and only useful for displaying for human consumption.

Variants

RexPrefix(u8)

the literal byte read for a rex prefix, 0x4_.

Tuple Fields of RexPrefix

0: u8

SegmentPrefix(Segment)

the segment selected by a segment override prefix. this is not necessarily the actual segement used in the instruction’s memory accesses, if any are made.

Tuple Fields of SegmentPrefix

0: Segment

Opcode(Opcode)

the opcode read for this instruction. this may be reported multiple times in an instruction if multiple spans of bits are necessary to determine the opcode. it is a bug if two different Opcode are indicated by different InnerDescription::Opcode reported from decoding the same instruction. this invariant is not well-tested, and may occur in practice.

Tuple Fields of Opcode

0: Opcode

OperandCode(OperandCodeWrapper)

the operand code indicating how to read operands for this instruction. this is an internal detail of yaxpeax-x86 but is typically named in a manner that can aid understanding the decoding process. OperandCode names are unstable, and this variant is only useful for displaying for human consumption.

Tuple Fields of OperandCode

0: OperandCodeWrapper

RegisterNumber(&'static str, u8, RegSpec)

a decoded register: a name for the bits used to decode it, the register number those bits specify, and the fully-constructed [long_mode::RegSpec] that was decoded.

Tuple Fields of RegisterNumber

0: &'static str1: u82: RegSpec

Misc(&'static str)

a miscellaneous string describing some bits of the instruction. this may describe a prefix, internal details of a prefix, error or constraints on an opcode, operand encoding details, or other items involved in an instruction.

Tuple Fields of Misc

0: &'static str

Number(&'static str, i64)

a number involved in the instruction: typically either a disaplacement or immediate. the string describes which. the i64 member is typically a sign-extended value from the appropriate original size, meaning there may be incorrect cases of a 65535u16 sign extending to -1. bug reports are highly encouraged for unexpected values.

Tuple Fields of Number

0: &'static str1: i64

Boundary(&'static str)

a boundary between two logically distinct sections of an instruction. these typically separate the leading prefix string (if any), opcode, and operands (if any). the included string describes which boundary this is. boundary names should not be considered stable, and are useful at most for displaying for human consumption.

Tuple Fields of Boundary

0: &'static str

Trait Implementations

impl Clone for InnerDescription

fn clone(&self) -> InnerDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InnerDescription

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

Formats the value using the given formatter.

impl Display for InnerDescription

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

Formats the value using the given formatter.

impl PartialEq<InnerDescription> for InnerDescription

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

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

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

This method tests for !=.

impl Eq for InnerDescription

impl StructuralEq for InnerDescription

impl StructuralPartialEq for InnerDescription