Struct AddressDiff

pub struct AddressDiff<T: AddressBase> { /* private fields */ }

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: Address> AddressDiff<T>

pub fn from_const(amount: T::Diff) -> Self

pub fn to_const(&self) -> T::Diff

impl<T: Address> AddressDiff<T>

pub fn one() -> Self

pub fn zero() -> Self

Trait Implementations

impl Add<AddressDiff<u16>> for u16

type Output = u16

The resulting type after applying the + operator.

fn add(self, other: AddressDiff<Self>) -> Self::Output

Performs the + operation.

impl Add<AddressDiff<u32>> for u32

type Output = u32

The resulting type after applying the + operator.

fn add(self, other: AddressDiff<Self>) -> Self::Output

Performs the + operation.

impl Add<AddressDiff<u64>> for u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: AddressDiff<Self>) -> Self::Output

Performs the + operation.

impl Add<AddressDiff<usize>> for usize

type Output = usize

The resulting type after applying the + operator.

fn add(self, other: AddressDiff<Self>) -> Self::Output

Performs the + operation.

impl AddAssign<AddressDiff<u16>> for u16

fn add_assign(&mut self, other: AddressDiff<Self>)

Performs the += operation.

impl AddAssign<AddressDiff<u32>> for u32

fn add_assign(&mut self, other: AddressDiff<Self>)

Performs the += operation.

impl AddAssign<AddressDiff<u64>> for u64

fn add_assign(&mut self, other: AddressDiff<Self>)

Performs the += operation.

impl AddAssign<AddressDiff<usize>> for usize

fn add_assign(&mut self, other: AddressDiff<Self>)

Performs the += operation.

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

where T::Diff: Clone,

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: Address> Debug for AddressDiff<T>

where T::Diff: Debug,

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

Formats the value using the given formatter.

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

where T::Diff: Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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

where T::Diff: PartialEq,

fn eq(&self, other: &AddressDiff<T>) -> 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<T: PartialOrd + AddressBase> PartialOrd for AddressDiff<T>

where T::Diff: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<AddressDiff<u16>> for u16

type Output = u16

The resulting type after applying the - operator.

fn sub(self, other: AddressDiff<Self>) -> Self::Output

Performs the - operation.

impl Sub<AddressDiff<u32>> for u32

type Output = u32

The resulting type after applying the - operator.

fn sub(self, other: AddressDiff<Self>) -> Self::Output

Performs the - operation.

impl Sub<AddressDiff<u64>> for u64

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: AddressDiff<Self>) -> Self::Output

Performs the - operation.

impl Sub<AddressDiff<usize>> for usize

type Output = usize

The resulting type after applying the - operator.

fn sub(self, other: AddressDiff<Self>) -> Self::Output

Performs the - operation.

impl SubAssign<AddressDiff<u16>> for u16

fn sub_assign(&mut self, other: AddressDiff<Self>)

Performs the -= operation.

impl SubAssign<AddressDiff<u32>> for u32

fn sub_assign(&mut self, other: AddressDiff<Self>)

Performs the -= operation.

impl SubAssign<AddressDiff<u64>> for u64

fn sub_assign(&mut self, other: AddressDiff<Self>)

Performs the -= operation.

impl SubAssign<AddressDiff<usize>> for usize

fn sub_assign(&mut self, other: AddressDiff<Self>)

Performs the -= operation.

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

where T::Diff: Copy,

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

where T::Diff: Eq,

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