Struct VirtualAddress

#[repr(transparent)]
pub struct VirtualAddress<const ALIGN: usize = 1> {
    pub addr: usize,
}

A virtual memory address of alignment ALIGN

Fields

addr: usize

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

Implementations

impl<const ALIGN: usize> VirtualAddress<ALIGN>

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

Creates a new VirtualAddress, panicking if the alignment is incorrect

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

Converts a VirtualAddress into a raw pointer

pub const unsafe fn align_unchecked<const NEW_ALIGN: usize>( self, ) -> VirtualAddress<NEW_ALIGN>

Forces a VirtualAddress to have a specific alignment

Safety

The address must be already aligned to the new alignment

pub const fn align_down<const NEW_ALIGN: usize>( self, ) -> VirtualAddress<NEW_ALIGN>

Returns the VirtualAddress less than or equal to self with the given alignment

pub const fn align_up<const NEW_ALIGN: usize>(self) -> VirtualAddress<NEW_ALIGN>

Returns the VirtualAddress greater than or equal to self with the given alignment

pub const fn align_down_runtime(self, new_alignment: usize) -> VirtualAddress<1>

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

Returns the VirtualAddress less than or equal to self with the given runtime alignment

pub const fn align_up_runtime(self, new_alignment: usize) -> VirtualAddress<1>

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

Returns the VirtualAddress greater than or equal to self with the given runtime alignment

pub const fn aligned<const N: usize>(self) -> VirtualAddress<N>

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

Trait Implementations

impl<const ALIGN: usize> Add<isize> for VirtualAddress<ALIGN>

type Output = VirtualAddress

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const ALIGN: usize> Add<usize> for VirtualAddress<ALIGN>

type Output = VirtualAddress

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const ALIGN: usize> Clone for VirtualAddress<ALIGN>

fn clone(&self) -> VirtualAddress<ALIGN>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const ALIGN: usize> Debug for VirtualAddress<ALIGN>

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

Formats the value using the given formatter.

impl<T: ?Sized> From<*const T> for VirtualAddress<1>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<const ALIGN: usize> Ord for VirtualAddress<ALIGN>

fn cmp(&self, other: &VirtualAddress<ALIGN>) -> 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<const A: usize, const B: usize> PartialEq<VirtualAddress<A>> for VirtualAddress<B>

fn eq(&self, other: &VirtualAddress<A>) -> 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<const A: usize, const B: usize> PartialOrd<VirtualAddress<A>> for VirtualAddress<B>

fn partial_cmp(&self, other: &VirtualAddress<A>) -> 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<const A: usize, const B: usize> Sub<VirtualAddress<A>> for VirtualAddress<B>

type Output = usize

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const ALIGN: usize> Sub<isize> for VirtualAddress<ALIGN>

type Output = VirtualAddress

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const ALIGN: usize> Sub<usize> for VirtualAddress<ALIGN>

type Output = VirtualAddress

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const ALIGN: usize> Copy for VirtualAddress<ALIGN>

impl<const ALIGN: usize> Eq for VirtualAddress<ALIGN>