Struct Instruction 

pub struct Instruction {
    pub address: Option<u64>,
    pub call_target: Vec<u64>,
    pub mnemonic_index: Option<i32>,
    pub operand_index: Vec<i32>,
    pub raw_bytes: Option<Vec<u8>>,
    pub comment_index: Vec<i32>,
}

Fields

address: Option<u64>

This will only be filled for instructions that do not just flow from the immediately preceding instruction. Regular instructions will have to calculate their own address by adding raw_bytes.size() to the previous instruction’s address.

call_target: Vec<u64>

If this is a call instruction and call targets could be determined they’ll be given here. Note that we may or may not have a flow graph for the target and thus cannot use an index into the flow graph table here. We could potentially use call graph nodes, but linking instructions to the call graph directly does not seem a good choice.

mnemonic_index: Option<i32>

Index into the mnemonic array of strings. Used for de-duping the data. The default value is used for the most common mnemonic in the executable.

operand_index: Vec<i32>

Indices into the operand tree. On X86 this can be 0, 1 or 2 elements long, 3 elements with VEX/EVEX. Implicit: operand sequence

raw_bytes: Option<Vec<u8>>

The unmodified input bytes corresponding to this instruction.

comment_index: Vec<i32>

Implicit: comment sequence

Implementations

impl Instruction

pub fn address(&self) -> u64

Returns the value of address, or the default value if address is unset.

pub fn mnemonic_index(&self) -> i32

Returns the value of mnemonic_index, or the default value if mnemonic_index is unset.

pub fn raw_bytes(&self) -> &[u8]

Returns the value of raw_bytes, or the default value if raw_bytes is unset.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl Default for Instruction

fn default() -> Self

Returns the “default value” for a type.

impl Message for Instruction

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Instruction

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Instruction