Struct memflow::types::address::Address

#[repr(transparent)]
pub struct Address(_);

This type represents a address on the target system. It internally holds a umem value but can also be used when working in 32-bit environments.

This type will not handle overflow for 32-bit or 64-bit addresses / lengths.

Implementations

impl Address

pub const NULL: Address

A address with the value of zero.

Examples

use memflow::types::Address;

println!("address: {}", Address::NULL);

pub const INVALID: Address

A address with an invalid value.

Examples

use memflow::types::Address;

println!("address: {}", Address::INVALID);

pub const fn null() -> Self

Returns an address with a value of zero.

Examples

use memflow::types::Address;

println!("address: {}", Address::null());

pub fn bit_mask<T: TryInto<u8>>(bits: Range<T>) -> Address

Creates a a bit mask. This function accepts an (half-open) range excluding the end bit from the mask.

Examples

use memflow::types::Address;

println!("mask: {}", Address::bit_mask(0..11));

pub const fn bit_mask_u8(bits: Range<u8>) -> Address

Creates a a bit mask (const version with u8 range). This function accepts an (half-open) range excluding the end bit from the mask.

Examples

use memflow::types::Address;

println!("mask: {}", Address::bit_mask(0..11));

pub const fn is_null(self) -> bool

Checks wether the address is zero or not.

Examples

use memflow::types::Address;

assert_eq!(Address::null().is_null(), true);
assert_eq!(Address::from(0x1000u64).is_null(), false);

pub fn non_null(self) -> Option<Address>

Converts the address to an Option that is None when it is null

Examples

use memflow::types::Address;

assert_eq!(Address::null().non_null(), None);
assert_eq!(Address::from(0x1000u64).non_null(), Some(Address::from(0x1000)));

pub const fn invalid() -> Self

Returns an address with a invalid value.

Examples

use memflow::types::Address;

println!("address: {}", Address::invalid());

pub const fn is_valid(self) -> bool

Checks wether the address is valid or not.

Examples

use memflow::types::Address;

assert_eq!(Address::invalid().is_valid(), false);
assert_eq!(Address::from(0x1000u64).is_valid(), true);

pub const fn to_umem(self) -> umem

Converts the address into a u64 value.

Examples

use memflow::types::{Address, umem};

let addr = Address::from(0x1000u64);
let addr_umem: umem = addr.to_umem();
assert_eq!(addr_umem, 0x1000);

pub const fn as_mem_aligned(self, mem_size: umem) -> Address

Aligns the containing address to the given page size. It returns the base address of the containing page.

Examples

use memflow::types::{Address, mem};

let addr = Address::from(0x1234);
let aligned = addr.as_mem_aligned(mem::kb(4));
assert_eq!(aligned, Address::from(0x1000));

pub const fn as_page_aligned(self, page_size: usize) -> Address

pub const fn bit_at(self, idx: u8) -> bool

Returns true or false wether the bit at the specified index is either 0 or 1. An index of 0 will check the least significant bit.

Examples

use memflow::types::Address;

let addr = Address::from(2);
let bit = addr.bit_at(1);
assert_eq!(bit, true);

pub fn extract_bits<T: TryInto<u8>>(self, bits: Range<T>) -> Address

Extracts the given range of bits by applying a corresponding bitmask. This function accepts an (half-open) range excluding the end bit from the mask.

Examples

use memflow::types::Address;

let addr = Address::from(123456789);
println!("bits[0..2] = {}", addr.extract_bits(0..2));

pub const fn wrapping_add(self, other: Self) -> Self

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

pub const fn wrapping_sub(self, other: Self) -> Self

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Trait Implementations

impl<'a, T: Into<umem> + Copy> Add<&'a T> for Address

Adds any compatible type reference to Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &'a T) -> Self

Performs the + operation.

impl Add<i16> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i16) -> Self

Performs the + operation.

impl Add<i32> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i32) -> Self

Performs the + operation.

impl Add<i64> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i64) -> Self

Performs the + operation.

impl Add<i8> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i8) -> Self

Performs the + operation.

impl Add<isize> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: isize) -> Self

Performs the + operation.

impl Add<u16> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: u16) -> Self

Performs the + operation.

impl Add<u32> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: u32) -> Self

Performs the + operation.

impl Add<u64> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: u64) -> Self

Performs the + operation.

impl Add<u8> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: u8) -> Self

Performs the + operation.

impl Add<usize> for Address

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: usize) -> Self

Performs the + operation.

impl AddAssign<i16> for Address

fn add_assign(&mut self, other: i16)

Performs the += operation.

impl AddAssign<i32> for Address

fn add_assign(&mut self, other: i32)

Performs the += operation.

impl AddAssign<i64> for Address

fn add_assign(&mut self, other: i64)

Performs the += operation.

impl AddAssign<i8> for Address

fn add_assign(&mut self, other: i8)

Performs the += operation.

impl AddAssign<isize> for Address

fn add_assign(&mut self, other: isize)

Performs the += operation.

impl AddAssign<u16> for Address

fn add_assign(&mut self, other: u16)

Performs the += operation.

impl AddAssign<u32> for Address

fn add_assign(&mut self, other: u32)

Performs the += operation.

impl AddAssign<u64> for Address

fn add_assign(&mut self, other: u64)

Performs the += operation.

impl AddAssign<u8> for Address

fn add_assign(&mut self, other: u8)

Performs the += operation.

impl AddAssign<usize> for Address

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl ByteSwap for Address

Implements byteswapping for the address

fn byte_swap(&mut self)

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Default for Address

Returns a address with a value of zero.

Examples

use memflow::types::Address;

assert_eq!(Address::default().is_null(), true);

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Address

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

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl From<Address> for PhysicalAddress

Converts a PhysicalAddress into a Address.

fn from(address: Address) -> Self

Performs the conversion.

impl<T: ?Sized> From<Address> for Pointer64<T>

fn from(address: Address) -> Pointer64<T>

Performs the conversion.

impl From<PhysicalAddress> for Address

Converts a PhysicalAddress into a Address.

fn from(address: PhysicalAddress) -> Self

Performs the conversion.

impl<U: PrimitiveAddress, T: ?Sized> From<Pointer<U, T>> for Address

Converts any Pointer into an Address.

fn from(ptr: Pointer<U, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<i16, T>> for Address

fn from(ptr: Pointer<i16, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<i32, T>> for Address

fn from(ptr: Pointer<i32, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<i64, T>> for Address

fn from(ptr: Pointer<i64, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<i8, T>> for Address

fn from(ptr: Pointer<i8, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<u8, T>> for Address

fn from(ptr: Pointer<u8, T>) -> Self

Performs the conversion.

impl<T: ?Sized> From<Pointer<usize, T>> for Address

fn from(ptr: Pointer<usize, T>) -> Self

Performs the conversion.

impl<U: PrimitiveAddress> From<U> for Address

Converts any PrimitiveAddress into an Address.

fn from(val: U) -> Self

Performs the conversion.

impl From<i16> for Address

fn from(item: i16) -> Self

Performs the conversion.

impl From<i32> for Address

fn from(item: i32) -> Self

Performs the conversion.

impl From<i64> for Address

fn from(item: i64) -> Self

Performs the conversion.

impl From<i8> for Address

fn from(item: i8) -> Self

Performs the conversion.

impl From<u8> for Address

fn from(item: u8) -> Self

Performs the conversion.

impl From<usize> for Address

fn from(item: usize) -> Self

Performs the conversion.

impl GetStaticEquivalent_ for Address

type StaticEquivalent = _static_Address

impl LowerHex for Address

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

Formats the value using the given formatter.

impl MmuTranslationBase for Address

fn get_pt_by_virt_addr(&self, _: Address) -> Address

Retrieves page table address by virtual address

fn get_pt_by_index(&self, idx: usize) -> (Address, usize)

Retrieves page table address, and its index by index within For instance, on Arm index 257 would return kernel page table address, and index 1. On X86, however, this is a no-op that returns underlying page table Address and idx.

fn pt_count(&self) -> usize

Retrieves number of page tables used by translation base. 1 on X86, 1-2 on Arm (Win32 Arm merges both page tables)

fn virt_addr_filter<B>(
    &self,
    spec: &ArchMmuSpec,
    addr: MemData<Address, B>,
    work_group: (&mut TranslationChunk<Self>, &mut MVec<'_, TranslateData<B>>),
    out_fail: &mut VtopFailureCallback<'_, B>
) where
    B: SplitAtIndex, 

fn fill_init_chunk<VI, B>(
    &self,
    spec: &ArchMmuSpec,
    out_fail: &mut VtopFailureCallback<'_, B>,
    addrs: &mut VI,
    (next_work_addrs, tmp_addrs): (&mut MVec<'_, TranslateData<B>>, &mut MVec<'_, TranslateData<B>>),
    work_vecs: &mut (MVec<'_, TranslationChunk<Address>>, MVec<'_, TranslateData<B>>),
    wait_vecs: &mut (MVec<'_, TranslationChunk<Address>>, MVec<'_, TranslateData<B>>)
) where
    VI: Iterator<Item = MemData<Address, B>>,
    B: SplitAtIndex, 

impl Ord for Address

fn cmp(&self, other: &Address) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Address> for Address

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

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

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

This method tests for !=.

impl PartialOrd<Address> for Address

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

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

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

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

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

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

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

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

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 Serialize for Address

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

Serialize this value into the given Serde serializer.

impl StableAbi for Address

type IsNonZeroType = <umem as __StableAbi>::IsNonZeroType

Whether this type has a single invalid bit-pattern.

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

const ABI_CONSTS: AbiConsts

const-equivalents of the associated types.

impl<'a, T: Into<umem> + Copy> Sub<&'a T> for Address

Subtracts any compatible type reference to Address

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &'a T) -> Self

Performs the - operation.

impl Sub<Address> for Address

Subtracts a Address from a Address resulting in a umem.

Examples

use memflow::types::Address;

assert_eq!(Address::from(10) - 5, Address::from(5));

type Output = imem

The resulting type after applying the - operator.

fn sub(self, other: Self) -> imem

Performs the - operation.

impl Sub<i16> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: i16) -> Address

Performs the - operation.

impl Sub<i32> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: i32) -> Address

Performs the - operation.

impl Sub<i64> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: i64) -> Address

Performs the - operation.

impl Sub<i8> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: i8) -> Address

Performs the - operation.

impl Sub<isize> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: isize) -> Address

Performs the - operation.

impl Sub<u16> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: u16) -> Address

Performs the - operation.

impl Sub<u32> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: u32) -> Address

Performs the - operation.

impl Sub<u64> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: u64) -> Address

Performs the - operation.

impl Sub<u8> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: u8) -> Address

Performs the - operation.

impl Sub<usize> for Address

type Output = Address

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Address

Performs the - operation.

impl SubAssign<i16> for Address

fn sub_assign(&mut self, other: i16)

Performs the -= operation.

impl SubAssign<i32> for Address

fn sub_assign(&mut self, other: i32)

Performs the -= operation.

impl SubAssign<i64> for Address

fn sub_assign(&mut self, other: i64)

Performs the -= operation.

impl SubAssign<i8> for Address

fn sub_assign(&mut self, other: i8)

Performs the -= operation.

impl SubAssign<isize> for Address

fn sub_assign(&mut self, other: isize)

Performs the -= operation.

impl SubAssign<u16> for Address

fn sub_assign(&mut self, other: u16)

Performs the -= operation.

impl SubAssign<u32> for Address

fn sub_assign(&mut self, other: u32)

Performs the -= operation.

impl SubAssign<u64> for Address

fn sub_assign(&mut self, other: u64)

Performs the -= operation.

impl SubAssign<u8> for Address

fn sub_assign(&mut self, other: u8)

Performs the -= operation.

impl SubAssign<usize> for Address

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl UpperHex for Address

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

Formats the value using the given formatter.

impl Copy for Address

impl Eq for Address

impl StructuralEq for Address

impl StructuralPartialEq for Address