Struct flp_framework::address::Word

#[repr(C)]
pub struct Word(_);

A Word is a value representing data, useful for its ability to be addressed and subsequently accessed by a WordAddr. Suppose you have some word address in wa and you want to ensure that the lowest bit of that word is set:

let w : Word = wa.load();
assert!(w.is_aligned_to(2) == false);

Trait Implementations

impl Address for Word

fn from_usize(val: usize) -> Word

Constructor for a word value from a raw usize.

let w = Word::from_usize(0xff);

fn as_usize(&self) -> usize

Deconstructor for a word value into a raw usize value.

let w = Word::from_usize(0xff);
assert!(w.as_usize() == 255);

fn verify(self) -> bool

All possible word values are valid:

let w = Word::from_usize(0xff);
assert!(w.verify());

fn load<T: Copy>(&self) -> T

A word cannot be accessed.

fn store<T>(&self, _value: T)

A word cannot be accessed.

fn memset(&self, _char: u8, _length: usize)

Raw word values are not writeable.

fn plus<A: Address>(&self, bytes: usize) -> A

Add some number of bytes to this address, producing an address of type A.

fn sub<A: Address>(&self, bytes: usize) -> A

Subtract some number of bytes from this address, producing an address of type A.

fn offset<T, A: Address>(&self, offset: usize) -> A

Offset this &self address some number of instances of type T, producing an address of type A.

fn is_zero(&self) -> bool

Is the value of this address equivalent to the (universal) null value?

fn align_up<A: Address>(&self, align: usize) -> A

Align this pointer up (increasing value) to the nearest address with a value aligned to align bytes. For example the following properties hold:

fn gte<A: Address>(&self, addr: A) -> bool

Is the value of this address greater than or equal to the value of the given address?

fn greater<A: Address>(&self, addr: A) -> bool

Is the value of this address greater than the value of the given address?

fn lte<A: Address>(&self, addr: A) -> bool

Is the value of this address less than or equal to the value of the given address?

fn less<A: Address>(&self, addr: A) -> bool

Is the value of this address less than the value of the given address?

fn is_aligned_to(&self, align: usize) -> bool

Is the value of this address exactly aligned to the given alignment?

fn from_ptr<T>(ptr: *const T) -> Self

Construct an address from an immutable constant Rust pointer type.

fn to_ptr<T>(&self) -> *const T

Deconstruct an address into an immutable constant Rust pointer type.

fn to_ptr_mut<T>(&self) -> *mut T

Construct an address from a mutable constant Rust pointer type.

fn zero() -> Self

Construct the (universal) null address.

fn diff<A: Address>(&self, another: A) -> usize

Compute the number of bytes before this address (exclusive) and after another address (inclusive).

impl Clone for Word

fn clone(&self) -> Word

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Word

impl Debug for Word

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

Display this address as a prettified alphanumeric hex string for debugging.

impl Display for Word

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

Display this address as a prettified alphanumeric hex string.

impl Eq for Word

impl Hash for Word

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Word

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

Address ordinality delegates to usize ordinality.

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

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

Restrict a value to a certain interval.

impl PartialEq<Word> for Word

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

Address equality delegates to usize equality

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

Address inequality delegates to usize equality

impl PartialOrd<Word> for Word

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

Address ordinality delegates to usize ordinality.

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Pointer for Word

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

Display this address as a prettified alphanumeric hex string.

impl StructuralEq for Word

impl UpperHex for Word

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

Format this address as an alphanumeric hex string.