Struct WordAddr 

pub struct WordAddr(pub u32);

A memory address expressed in words

Only capable of representing aligned addresses, as adjacent WordAddrs are a word apart.

Tuple Fields

0: u32

Implementations

impl WordAddr

pub const fn baddr(self) -> ByteAddr

Convert to a ByteAddr

pub const fn page_idx(&self) -> u32

Gives the crate::image::Page containing this memory address

pub const fn page_subaddr(&self) -> WordAddr

The subaddress of this address relative to its containing crate::image::Page

The number of words this address is beyond the first word of the page which contains it.

pub const fn inc(&mut self)

Increments this address to the next word

This increments the address without returning any value.

pub const fn postfix_inc(&mut self) -> Self

Increments this address to the next word and returns its previous value

This is a postfixing increment, analogous to addr++ in C; the value this evaluates to is the value prior to the increment.

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.

Trait Implementations

impl Add for WordAddr

type Output = WordAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for WordAddr

type Output = WordAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u32> for WordAddr

type Output = WordAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for WordAddr

type Output = WordAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for WordAddr

fn add_assign(&mut self, rhs: WordAddr)

Performs the += operation.

impl AddAssign<u32> for WordAddr

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl AddAssign<usize> for WordAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for WordAddr

fn clone(&self) -> WordAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WordAddr

impl Debug for WordAddr

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

Formats the value using the given formatter.

impl Eq for WordAddr

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 WordAddr

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 WordAddr

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WordAddr

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

impl Sub for WordAddr

type Output = WordAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u32> for WordAddr

type Output = WordAddr

The resulting type after applying the - operator.

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

Performs the - operation.