Struct ByteAddr 

pub struct ByteAddr(pub u32);

A memory address expressed in bytes

Tuple Fields

0: u32

Implementations

impl ByteAddr

pub const fn waddr(self) -> WordAddr

Convert to a WordAddr

If the address is not aligned to a word boundary, this will return the highest aligned address smaller than the input address.

pub const fn page_idx(&self) -> u32

Gives the Page containing this memory address

pub const fn page_subaddr(&self) -> ByteAddr

The subaddress of this address relative to its containing Page

The number of bytes this address is beyond the first byte of the page which contains it.

pub fn waddr_aligned(self) -> Option<WordAddr>

Convert to a WordAddr if aligned

If the address is aligned to a word boundary, this will return the WordAddr for this memory location. If it is not aligned, it returns None.

pub const fn is_aligned(&self) -> bool

Reports if the address is aligned

Returns true if the address is aligned to a word boundary, otherwise returns false

pub const fn is_null(&self) -> bool

Reports if the address is null

The address 0x00000000 is null and will return true, for all others returns false.

pub const fn checked_add(self, rhs: u32) -> Option<Self>

Add an offset to an address, returning None on overflow.

pub const fn saturating_add(self, rhs: u32) -> Self

Add an offset to an address, saturating on overflow.

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

Add an offset to an address

This will wrap on overflow, e.g. 0xFFFFFFFF + 0x00000001 is 0x00000000.

pub const fn subaddr(&self) -> u32

The subaddress of this address relative to its containing word

The number of bytes this address is beyond the previous aligned address. So for example an aligned address will have a subaddress of 0, while the address 0x00003001 will have subaddress 1.

Trait Implementations

impl Add for ByteAddr

type Output = ByteAddr

The resulting type after applying the + operator.

fn add(self, rhs: ByteAddr) -> ByteAddr

Performs the + operation.

impl Add<i32> for ByteAddr

type Output = ByteAddr

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> Self::Output

Performs the + operation.

impl Add<u32> for ByteAddr

type Output = ByteAddr

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> Self::Output

Performs the + operation.

impl Add<usize> for ByteAddr

type Output = ByteAddr

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign for ByteAddr

fn add_assign(&mut self, rhs: ByteAddr)

Performs the += operation.

impl AddAssign<u32> for ByteAddr

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl AddAssign<usize> for ByteAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for ByteAddr

fn clone(&self) -> ByteAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteAddr

impl Debug for ByteAddr

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

Formats the value using the given formatter.

impl Eq for ByteAddr

impl From<ByteAddr> for WordAddr

fn from(addr: ByteAddr) -> Self

Converts to this type from the input type.

impl From<WordAddr> for ByteAddr

fn from(addr: WordAddr) -> Self

Converts to this type from the input type.

impl Hash for ByteAddr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ByteAddr

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ByteAddr

fn partial_cmp(&self, other: &ByteAddr) -> 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 StructuralPartialEq for ByteAddr

impl Sub for ByteAddr

type Output = ByteAddr

The resulting type after applying the - operator.

fn sub(self, rhs: ByteAddr) -> ByteAddr

Performs the - operation.