Struct VirtualAddress 

#[repr(transparent)]
pub struct VirtualAddress {
    pub addr: usize,
}

A virtual memory address

Fields

addr: usize

The underlying address

Implementations

impl VirtualAddress

pub const fn is_higher_half(self) -> bool

Returns true if the VirtualAddress is in the upper half of the address space, i.e. kernelspace

pub const fn new(addr: usize) -> Self

Creates a new VirtualAddress

pub const fn as_ptr(self) -> *mut u8

Converts a VirtualAddress into a raw pointer

pub const fn align_down_to_page(self) -> RawPage

Returns the closest RawPage at or below the current address

pub const fn align_up_to_page(self) -> RawPage

Returns the closest RawPage at or above the current address

pub const fn aligned_to(self, align: usize) -> bool

Returns true if the PhysicalAddress is aligned to align

Panics

If align is not a power of two

pub const fn saturating_add(self, rhs: usize) -> Self

Computed self + rhs saturating when the VirtualAddress reaches [usize::MAX]

pub const fn saturating_sub(self, rhs: usize) -> Self

Computed self - rhs saturating when the VirtualAddress reaches 0

pub const fn to_physical(self) -> PhysicalAddress

Converts an VirtualAddress in the physical page map region into an PhysicalAddress

Panics

Panics if the address is not in the physical page map region on a best effort basis

Trait Implementations

impl Add<isize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for VirtualAddress

fn clone(&self) -> VirtualAddress

Returns a duplicate 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<T: ?Sized> From<*const T> for VirtualAddress

fn from(value: *const T) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<*mut T> for VirtualAddress

fn from(value: *mut T) -> Self

Converts to this type from the input type.

impl From<RawPage> for VirtualAddress

fn from(value: RawPage) -> Self

Converts to this type from the input type.

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 LowerHex for VirtualAddress

fn fmt(&self, f: &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) -> 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 VirtualAddress

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

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 Step for VirtualAddress

fn steps_between(start: &Self, end: &Self) -> (usize, Option<usize>)

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

Returns the bounds on the number of successor steps required to get from start to end like [Iterator::size_hint()][Iterator::size_hint()].

fn forward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

impl Sub<isize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for VirtualAddress

Returns the number of bytes between self and rhs

type Output = usize

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for VirtualAddress

impl Eq for VirtualAddress

impl StructuralPartialEq for VirtualAddress