Struct memory_structs::VirtualAddress

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

A virtual memory address, which is a usize under the hood.

Implementations

impl VirtualAddress

pub fn new(addr: usize) -> Option<VirtualAddress>

Creates a new VirtualAddress, returning an error if the address is not canonical.

This is useful for checking whether an address is valid before using it. For example, on x86_64, virtual addresses are canonical if their upper bits (64:48] are sign-extended from bit 47, and physical addresses are canonical if their upper bits (64:52] are 0.

pub const fn new_canonical(addr: usize) -> VirtualAddress

Creates a new VirtualAddress that is guaranteed to be canonical.

pub const fn zero() -> VirtualAddress

Creates a new VirtualAddress with a value 0.

pub const fn value(&self) -> usize

Returns the underlying usize value for this VirtualAddress.

pub const fn page_offset(&self) -> usize

Returns the offset from the page boundary specified by this `VirtualAddress.

For example, if the [PAGE_SIZE] is 4096 (4KiB), then this will return the least significant 12 bits (12:0] of this VirtualAddress.

Trait Implementations

impl Add<VirtualAddress> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> VirtualAddress

Performs the + operation.

impl AddAssign<VirtualAddress> for VirtualAddress

fn add_assign(&mut self, rhs: VirtualAddress)

Performs the += operation.

impl AddAssign<usize> for VirtualAddress

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Binary for VirtualAddress

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

Formats the value using the given formatter.

impl BitAnd<VirtualAddress> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the & operator.

fn bitand(self, rhs: VirtualAddress) -> VirtualAddress

Performs the & operation.

impl BitAndAssign<VirtualAddress> for VirtualAddress

fn bitand_assign(&mut self, rhs: VirtualAddress)

Performs the &= operation.

impl BitOr<VirtualAddress> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the | operator.

fn bitor(self, rhs: VirtualAddress) -> VirtualAddress

Performs the | operation.

impl BitOrAssign<VirtualAddress> for VirtualAddress

fn bitor_assign(&mut self, rhs: VirtualAddress)

Performs the |= operation.

impl BitXor<VirtualAddress> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: VirtualAddress) -> VirtualAddress

Performs the ^ operation.

impl BitXorAssign<VirtualAddress> for VirtualAddress

fn bitxor_assign(&mut self, rhs: VirtualAddress)

Performs the ^= operation.

impl Clone for VirtualAddress

fn clone(&self) -> VirtualAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualAddress

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

Formats the value using the given formatter.

impl Default for VirtualAddress

fn default() -> VirtualAddress

Returns the “default value” for a type.

impl Display for VirtualAddress

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

Formats the value using the given formatter.

impl Hash for VirtualAddress

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 Into<usize> for VirtualAddress

fn into(self) -> usize

Converts this type into the (usually inferred) input type.

impl LowerHex for VirtualAddress

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

Formats the value using the given formatter.

impl Octal for VirtualAddress

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

Formats the value using the given formatter.

impl Ord for VirtualAddress

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VirtualAddress> for VirtualAddress

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<VirtualAddress> for VirtualAddress

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

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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 VirtualAddress

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

Formats the value using the given formatter.

impl Sub<VirtualAddress> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> VirtualAddress

Performs the - operation.

impl SubAssign<VirtualAddress> for VirtualAddress

fn sub_assign(&mut self, rhs: VirtualAddress)

Performs the -= operation.

impl SubAssign<usize> for VirtualAddress

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl UpperHex for VirtualAddress

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

Formats the value using the given formatter.

impl Copy for VirtualAddress

impl Eq for VirtualAddress

impl FromBytes for VirtualAddress

impl StructuralEq for VirtualAddress

impl StructuralPartialEq for VirtualAddress