Struct Address

pub struct Address(/* private fields */);

Describes an address in memory.

Addresses are 64 bits wide.

Implementations

impl Address

pub const fn new(value: u64) -> Self

Creates a new Address from an u64.

use osiris_data::data::identification::Address;
assert_eq!(Address::new(0), Address::default())

pub const fn to_u64(&self) -> u64

Gets the address value as an u64.

pub const fn from_word(word: Word) -> Self

Creates a new Address from a Word.

pub fn from<T: Identifier>(identifier: T) -> Self

Creates a new Address from any Identifier.

pub const fn to_word(&self) -> Word

Gets the address value as a machine’s Word to manipulate it with memory.

pub fn increment(&mut self)

Increment the address value.

pub fn offset(&self, offset: u64) -> Address

Returns a new Address with an offset.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate 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

fn default() -> Address

Returns the “default value” for a type.

impl Hash for Address

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

fn to_usize(&self) -> usize

Gets the address value as an usize.

impl Index<Address> for Array

type Output = Word

The returned type after indexing.

fn index(&self, index: Address) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Address> for Memory

type Output = Word

The returned type after indexing.

fn index(&self, index: Address) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Address> for Array

fn index_mut(&mut self, index: Address) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Address> for Memory

fn index_mut(&mut self, index: Address) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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

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 Address

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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

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

impl Eq for Address

impl StructuralPartialEq for Address