VirtualAddress

Struct VirtualAddress 

Source
#[repr(transparent)]
pub struct VirtualAddress(MemoryAddress);
Expand description

Virtual memory address.

A thin wrapper around MemoryAddress that denotes virtual addresses. It does not validate canonicality at runtime; it only carries the kind of address at the type level so you don’t accidentally mix virtual and physical values.

§Semantics

§Invariants

  • No invariant beyond “this is intended to be a virtual address”.
  • Alignment is only guaranteed for values returned from page::<S>().

§Examples

let va = VirtualAddress::new(0xFFFF_FFFF_8000_1234);
let (vp, off) = va.split::<Size4K>();
assert_eq!(vp.base().as_u64() & (Size4K::SIZE - 1), 0);
assert_eq!(vp.join(off).as_u64(), va.as_u64());

Tuple Fields§

§0: MemoryAddress

Implementations§

Source§

impl VirtualAddress

Source

pub fn from_nonnull<T>(ptr: NonNull<T>) -> Self

Source

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

Source

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

Source

pub const fn as_u64(self) -> u64

Source

pub const fn page<S: PageSize>(self) -> VirtualPage<S>

Source

pub const fn offset<S: PageSize>(self) -> MemoryAddressOffset<S>

Source

pub const fn split<S: PageSize>( self, ) -> (VirtualPage<S>, MemoryAddressOffset<S>)

Trait Implementations§

Source§

impl Clone for VirtualAddress

Source§

fn clone(&self) -> VirtualAddress

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VirtualAddress

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VirtualAddress

Source§

fn default() -> VirtualAddress

Returns the “default value” for a type. Read more
Source§

impl Display for VirtualAddress

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S> From<VirtualPage<S>> for VirtualAddress
where S: PageSize,

Source§

fn from(value: VirtualPage<S>) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for VirtualAddress

Source§

fn from(v: u64) -> Self

Converts to this type from the input type.
Source§

impl Hash for VirtualAddress

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for VirtualAddress

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for VirtualAddress

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for VirtualAddress

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for VirtualAddress

Source§

impl Eq for VirtualAddress

Source§

impl StructuralPartialEq for VirtualAddress

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.