Struct VirtAddr

pub struct VirtAddr(/* private fields */);

A virtual memory address on riscv64.

64-bit addresses on riscv64 “must have bits 63–48 all equal to bit 47, or else a page-fault exception will occur.”

Implementations

impl VirtAddr

pub const unsafe fn new_unsafe(addr: u64) -> VirtAddr

Creates a new address, without any checks.

Safety

If addr does not comply with the platforms requirements for this address type, this can lead to UB in functions relying on the compliance or when using the requirements.

pub const fn is_null(self) -> bool

Convenience method for checking if an address is null.

pub const fn zero() -> VirtAddr

Creates an address that points to 0.

pub const fn as_u64(self) -> u64

Converts the address to an u64.

impl VirtAddr

pub const fn new(addr: u64) -> VirtAddr

Creates a new canonical virtual address.

pub const fn try_new(addr: u64) -> Result<VirtAddr, VirtAddrNotValid>

Tries to create a new canonical virtual address.

pub const fn new_truncate(addr: u64) -> VirtAddr

Creates a new canonical virtual address.

This function performs sign extension of bit 47 to make the address canonical, overwriting bits 48 to 63.

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

Creates a virtual address from the given pointer

pub const fn as_ptr<T>(self) -> *const T

Converts the address to a raw pointer.

pub const fn as_mut_ptr<T>(self) -> *mut T

Converts the address to a mutable raw pointer.

pub const fn as_usize(&self) -> usize

pub fn base_page_offset(self) -> u64

Offset within the 4 KiB page.

pub fn large_page_offset(self) -> u64

Offset within the 2 MiB page.

pub fn giga_page_offset(self) -> u64

Offset within the 1 GiB page.

pub fn tera_page_offset(self) -> u64

Offset within the 512 GiB page.

Trait Implementations

impl Add<u64> for VirtAddr

type Output = VirtAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u64> for VirtAddr

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign<usize> for VirtAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Align<u64> for VirtAddr

fn align_down(self, align: u64) -> Self

Align address downwards.

fn align_up(self, align: u64) -> Self

Align address upwards.

fn is_aligned_to(self, align: A) -> bool

Checks whether the address has the demanded alignment.

impl Binary for VirtAddr

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

Formats the value using the given formatter.

impl BitAnd<u64> for VirtAddr

type Output = u64

The resulting type after applying the & operator.

fn bitand(self, rhs: u64) -> Self::Output

Performs the & operation.

impl BitAndAssign<u64> for VirtAddr

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitOr<u64> for VirtAddr

type Output = u64

The resulting type after applying the | operator.

fn bitor(self, rhs: u64) -> Self::Output

Performs the | operation.

impl BitOrAssign<u64> for VirtAddr

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitXor<u64> for VirtAddr

type Output = u64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u64) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<u64> for VirtAddr

fn bitxor_assign(&mut self, rhs: u64)

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 From<u64> for VirtAddr

fn from(addr: u64) -> VirtAddr

Converts to this type from the input type.

impl From<usize> for VirtAddr

fn from(addr: usize) -> VirtAddr

Converts to this type from the input type.

impl Hash for VirtAddr

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 VirtAddr

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

Formats the value using the given formatter.

impl MemoryAddress for VirtAddr

type RAW = u64

Inner address type

fn raw(self) -> Self::RAW

Get the raw underlying address value.

impl Octal 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) -> 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 VirtAddr

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

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 Pointer for VirtAddr

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

Formats the value using the given formatter.

impl Shl<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for VirtAddr

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for VirtAddr

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u64> for VirtAddr

type Output = VirtAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for VirtAddr

type Output = u64

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u64> for VirtAddr

fn sub_assign(&mut self, rhs: u64)

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 StructuralPartialEq for VirtAddr