Struct yaxpeax_arch::AddressDiff

pub struct AddressDiff<T: AddressDiffAmount> { /* fields omitted */ }

a struct describing the differece between some pair of A: Address. this is primarily useful in describing the size of an instruction, or the relative offset of a branch.

for any address type A, the following must hold:

use yaxpeax_arch::AddressBase;
fn diff_check<A: AddressBase + core::fmt::Debug>(left: A, right: A) {
    let diff = left.diff(&right);
    if let Some(offset) = diff {
        assert_eq!(left.wrapping_offset(offset), right);
    }
}

which is to say, yaxpeax assumes associativity holds when diff yields a Some.

Implementations

impl<T: AddressDiffAmount> AddressDiff<T>

pub fn from_const(amount: T) -> Self

impl<T: AddressDiffAmount> AddressDiff<T>

pub fn one() -> Self

pub fn zero() -> Self

Trait Implementations

impl<T: Clone + AddressDiffAmount> Clone for AddressDiff<T>

fn clone(&self) -> AddressDiff<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: AddressDiffAmount + Debug> Debug for AddressDiff<T>

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

Formats the value using the given formatter.

impl<'de, T: AddressDiffAmount> Deserialize<'de> for AddressDiff<T> where
    T: AddressDiffAmount, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Ord + AddressDiffAmount> Ord for AddressDiff<T>

fn cmp(&self, other: &AddressDiff<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq + AddressDiffAmount> PartialEq<AddressDiff<T>> for AddressDiff<T>

fn eq(&self, other: &AddressDiff<T>) -> bool

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

fn ne(&self, other: &AddressDiff<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + AddressDiffAmount> PartialOrd<AddressDiff<T>> for AddressDiff<T>

fn partial_cmp(&self, other: &AddressDiff<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: AddressDiffAmount> Serialize for AddressDiff<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Copy + AddressDiffAmount> Copy for AddressDiff<T>

impl<T: Eq + AddressDiffAmount> Eq for AddressDiff<T>

impl<T: AddressDiffAmount> StructuralEq for AddressDiff<T>

impl<T: AddressDiffAmount> StructuralPartialEq for AddressDiff<T>