Struct capstone::Capstone

pub struct Capstone { /* fields omitted */ }

An instance of the capstone disassembler

Methods

impl Capstone

pub fn new() -> CapstoneBuilder

Create a new instance of the decompiler using the builder pattern interface. This is the recommended interface to Capstone.

use capstone::prelude::*;
let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build();

pub fn new_raw<T: Iterator<Item = ExtraMode>>(
    arch: Arch,
    mode: Mode,
    extra_mode: T,
    endian: Option<Endian>
) -> CsResult<Capstone>

Create a new instance of the decompiler using the "raw" interface. The user must ensure that only sensical Arch/Mode combinations are used.

use capstone::{Arch, Capstone, NO_EXTRA_MODE, Mode};
let cs = Capstone::new_raw(Arch::X86, Mode::Mode64, NO_EXTRA_MODE, None);
assert!(cs.is_ok());

pub fn disasm_all(&self, code: &[u8], addr: u64) -> CsResult<Instructions>

Disassemble all instructions in buffer

pub fn disasm_count(
    &self,
    code: &[u8],
    addr: u64,
    count: usize
) -> CsResult<Instructions>

Disassemble count instructions in code

pub fn set_extra_mode<T: Iterator<Item = ExtraMode>>(
    &mut self,
    extra_mode: T
) -> CsResult<()>

Set extra modes in addition to normal mode

pub fn set_syntax(&mut self, syntax: Syntax) -> CsResult<()>

Set the assembly syntax (has no effect on some platforms)

pub fn set_mode(&mut self, mode: Mode) -> CsResult<()>

Sets the engine's disassembly mode. Be careful, various combinations of modes aren't supported See the capstone-sys documentation for more information.

pub fn set_detail(&mut self, enable_detail: bool) -> CsResult<()>

Controls whether to capstone will generate extra details about disassembled instructions.

Pass true to enable detail or false to disable detail.

pub fn reg_name(&self, reg_id: RegId) -> Option<String>

Converts a register id reg_id to a String containing the register name.

pub fn insn_name(&self, insn_id: InsnId) -> Option<String>

Converts an instruction id insn_id to a String containing the instruction name.

Note: This function ignores the current syntax and uses the default syntax.

pub fn group_name(&self, group_id: InsnGroupId) -> Option<String>

Converts a group id group_id to a String containing the group name.

pub fn insn_detail<'s, 'i: 's>(
    &'s self,
    insn: &'i Insn
) -> CsResult<InsnDetail<'i>>

Returns Detail structure for a given instruction

Requires:

1. Instruction was created with detail enabled
2. Skipdata is disabled
3. Capstone was not compiled in diet mode

pub fn insn_belongs_to_group(
    &self,
    insn: &Insn,
    group_id: InsnGroupId
) -> CsResult<bool>

Returns whether the instruction insn belongs to the group with id group_id.

pub fn insn_group_ids<'i>(&self, insn: &'i Insn) -> CsResult<InsnGroupIter<'i>>

Returns groups ids to which an instruction belongs.

pub fn register_id_is_read(&self, insn: &Insn, reg_id: RegId) -> CsResult<bool>

Checks if an instruction implicitly reads a register with id reg_id.

pub fn read_register_ids<'i>(
    &self,
    insn: &'i Insn
) -> CsResult<RegsIter<'i, u8>>

Returns list of ids of registers that are implicitly read by instruction insn.

pub fn register_id_is_written(
    &self,
    insn: &Insn,
    reg_id: RegId
) -> CsResult<bool>

Checks if an instruction implicitly writes to a register with id reg_id.

pub fn write_register_ids<'i>(
    &self,
    insn: &'i Insn
) -> CsResult<RegsIter<'i, u8>>

Returns a list of ids of registers that are implicitly written to by the instruction insn.

pub fn lib_version() -> (u32, u32)

Returns a tuple (major, minor) indicating the version of the capstone C library.

pub fn supports_arch(arch: Arch) -> bool

Returns whether the capstone library supports a given architecture.

pub fn is_diet() -> bool

Returns whether the capstone library was compiled in diet mode.

Trait Implementations

impl Debug for Capstone

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Drop for Capstone

fn drop(&mut self)

Executes the destructor for this type.