Struct memory_addr::VirtAddr

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

A virtual memory address.

It’s a wrapper type around an usize.

Implementations

impl VirtAddr

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

Converts an usize to a virtual address.

pub const fn as_usize(self) -> usize

Converts the address to an usize.

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

Converts the virtual address to a raw pointer.

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

Converts the virtual address to a mutable raw pointer.

pub fn align_down<U>(self, align: U) -> Selfwhere U: Into<usize>,

Aligns the address downwards to the given alignment.

See the align_down function for more information.

pub fn align_up<U>(self, align: U) -> Selfwhere U: Into<usize>,

Aligns the address upwards to the given alignment.

See the align_up function for more information.

pub fn align_offset<U>(self, align: U) -> usizewhere U: Into<usize>,

Returns the offset of the address within the given alignment.

See the align_offset function for more information.

pub fn is_aligned<U>(self, align: U) -> boolwhere U: Into<usize>,

Checks whether the address has the demanded alignment.

See the is_aligned function for more information.

pub fn align_down_4k(self) -> Self

Aligns the address downwards to 4096 (bytes).

pub fn align_up_4k(self) -> Self

Aligns the address upwards to 4096 (bytes).

pub fn align_offset_4k(self) -> usize

Returns the offset of the address within a 4K-sized page.

pub fn is_aligned_4k(self) -> bool

Checks whether the address is 4K-aligned.

Trait Implementations

impl Add<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for VirtAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for VirtAddr

fn clone(&self) -> VirtAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtAddr

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

Formats the value using the given formatter.

impl Default for VirtAddr

fn default() -> VirtAddr

Returns the “default value” for a type.

impl From<VirtAddr> for usize

fn from(addr: VirtAddr) -> usize

Converts to this type from the input type.

impl From<usize> for VirtAddr

fn from(addr: usize) -> Self

Converts to this type from the input type.

impl LowerHex for VirtAddr

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

Formats the value using the given formatter.

impl Ord for VirtAddr

fn cmp(&self, other: &VirtAddr) -> 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<VirtAddr> for VirtAddr

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

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

type Output = VirtAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for VirtAddr

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl UpperHex for VirtAddr

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

Formats the value using the given formatter.

impl Copy for VirtAddr

impl Eq for VirtAddr

impl StructuralEq for VirtAddr

impl StructuralPartialEq for VirtAddr