Struct memflow::types::address::Address

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

This type represents a address on the target system. It internally holds a u64 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<u64>>(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 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 as_u32(self) -> u32

Converts the address into a u32 value.

Examples

use memflow::types::Address;

let addr = Address::from(0x1000u64);
let addr_u32: u32 = addr.as_u32();
assert_eq!(addr_u32, 0x1000);

pub const fn as_u64(self) -> u64

Converts the address into a u64 value.

Examples

use memflow::types::Address;

let addr = Address::from(0x1000u64);
let addr_u64: u64 = addr.as_u64();
assert_eq!(addr_u64, 0x1000);

pub const fn as_usize(self) -> usize

Converts the address into a usize value.

Examples

use memflow::types::Address;

let addr = Address::from(0x1000u64);
let addr_usize: usize = addr.as_usize();
assert_eq!(addr_usize, 0x1000);

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

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

Examples

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

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

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<u64>>(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));

Trait Implementations

impl<'a, T: Into<u64> + 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<usize> for Address

Adds a usize to a Address which results in a Address.

Examples

use memflow::types::Address;
assert_eq!(Address::from(10) + 5usize, Address::from(15));

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for Address

Adds a usize to a Address.

Examples

use memflow::types::Address;

let mut addr = Address::from(10);
addr += 5;
assert_eq!(addr, Address::from(15));

fn add_assign(&mut self, other: usize)

Performs the += operation.

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

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

impl From<Address> for PhysicalAddress

Converts a Address into a PhysicalAddress with no page information attached.

fn from(address: Address) -> Self

Performs the conversion.

impl From<PhysicalAddress> for Address

Converts a PhysicalAddress into a Address.

fn from(address: PhysicalAddress) -> Self

Performs the conversion.

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

fn from(ptr: Pointer32<T>) -> Address

Performs the conversion.

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

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

Performs the conversion.

impl From<i32> for Address

Constructs an Address from a i32 value.

fn from(item: i32) -> Self

Performs the conversion.

impl From<u32> for Address

Constructs an Address from a u32 value.

fn from(item: u32) -> Self

Performs the conversion.

impl From<u64> for Address

Constructs an Address from a u64 value.

fn from(item: u64) -> Self

Performs the conversion.

impl From<usize> for Address

Constructs an Address from a usize value.

fn from(item: usize) -> Self

Performs the conversion.

impl LowerHex for Address

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

Formats the value using the given formatter.

impl Ord for Address

fn cmp(&self, other: &Address) -> 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

🔬 This is a nightly-only experimental API. (clamp)

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: &Address) -> bool

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

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

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

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

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

fn ge(&self, other: &Address) -> 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 StructuralEq for Address

impl StructuralPartialEq for Address

impl<'a, T: Into<u64> + 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 usize.

Examples

use memflow::types::Address;

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

type Output = usize

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for Address

Subtracts a usize from a Address resulting in a Address.

type Output = Address

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for Address

Subtracts a usize from a Address.

Examples

use memflow::types::Address;

let mut addr = Address::from(10);
addr -= 5;
assert_eq!(addr, Address::from(5));

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.