Skip to main content

Explanation

Struct Explanation 

Source
pub struct Explanation {
Show 13 fields pub mnemonic: String, pub prefix: Option<String>, pub summary: String, pub group: String, pub effect: String, pub reads: Vec<String>, pub writes: Vec<String>, pub flags_modified: Vec<Flag>, pub flags_read: Vec<Flag>, pub flags_undefined: Vec<Flag>, pub notes: Option<String>, pub approximate: bool, pub concrete: Option<String>,
}
Expand description

A rendered explanation of one instruction.

Fields§

§mnemonic: String

The mnemonic as written, lowercase.

§prefix: Option<String>

Any instruction prefix that was present.

§summary: String

A one-line description of the instruction.

§group: String

The category it belongs to.

§effect: String

What it does, with the actual operands substituted.

§reads: Vec<String>

What it reads, as display names.

§writes: Vec<String>

What it writes, as display names.

§flags_modified: Vec<Flag>

Flags it modifies.

§flags_read: Vec<Flag>

Flags it consults.

§flags_undefined: Vec<Flag>

Flags it leaves architecturally undefined.

§notes: Option<String>

Extra guidance.

§approximate: bool

Whether the effect is described only approximately.

§concrete: Option<String>

The effect with live register values substituted, when they are known.

RAX ← RAX + RBX becomes RAX ← 1 + 2. This is the difference between a reference card and watching the machine work, so it is computed whenever the debugger is stopped and left None otherwise.

Implementations§

Source§

impl Explanation

Source

pub fn lines(&self) -> Vec<(String, String)>

Renders the explanation as the lines the panel displays.

Sections with nothing to say are omitted rather than shown empty.

Source§

impl Explanation

Source

pub fn with_values(self, values: &dyn RegisterValues) -> Self

Fills in Explanation::concrete from live register values.

Only operands that are plainly registers are substituted. An immediate already shows its value, and a memory operand would need a memory read to resolve — showing [rbx+8] unchanged is honest, whereas printing a guessed address would not be.

Trait Implementations§

Source§

impl Clone for Explanation

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Explanation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Explanation

Source§

impl PartialEq for Explanation

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Explanation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more