Struct x86::bits64::paging::VAddr

#[repr(transparent)]pub struct VAddr(pub u64);

A wrapper for a virtual address.

Methods

impl VAddr

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

Convert from u64

pub const fn from_usize(v: usize) -> Self

Convert from usize

pub const fn as_u64(self) -> u64

Convert to u64

pub const fn as_usize(self) -> usize

Convert to usize

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

Convert to mutable pointer.

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

Convert to pointer.

pub const fn zero() -> Self

Physical Address zero.

pub fn is_zero(self) -> bool

Is zero?

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 huge_page_offset(self) -> u64

Offset within the 1 GiB page.

pub fn align_down_to_base_page(self) -> Self

Return address of nearest 4 KiB page (lower or equal than self).

pub fn align_down_to_large_page(self) -> Self

Return address of nearest 2 MiB page (lower or equal than self).

pub fn align_down_to_huge_page(self) -> Self

Return address of nearest 1 GiB page (lower or equal than self).

pub fn align_up_to_base_page(self) -> Self

Return address of nearest 4 KiB page (higher or equal than self).

pub fn align_up_to_large_page(self) -> Self

Return address of nearest 2 MiB page (higher or equal than self).

pub fn align_up_to_huge_page(self) -> Self

Return address of nearest 1 GiB page (higher or equal than self).

pub fn is_base_page_aligned(self) -> bool

Is this address aligned to a 4 KiB page?

pub fn is_large_page_aligned(self) -> bool

Is this address aligned to a 2 MiB page?

pub fn is_huge_page_aligned(self) -> bool

Is this address aligned to a 1 GiB page?

pub fn is_aligned<U>(self, align: U) -> bool where
    U: Into<u64> + Copy, 

Is this address aligned to align?

Note

align must be a power of two.

Trait Implementations

impl Add<VAddr> for VAddr

type Output = VAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u64> for VAddr

type Output = VAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for VAddr

type Output = VAddr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<VAddr> for VAddr

fn add_assign(&mut self, other: VAddr)

Performs the += operation.

impl AddAssign<u64> for VAddr

fn add_assign(&mut self, offset: u64)

Performs the += operation.

impl AddAssign<usize> for VAddr

fn add_assign(&mut self, offset: usize)

Performs the += operation.

impl Binary for VAddr

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

Formats the value using the given formatter.

impl BitAnd<VAddr> for VAddr

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<i32> for VAddr

type Output = VAddr

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<u64> for VAddr

type Output = VAddr

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<usize> for VAddr

type Output = VAddr

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<VAddr> for VAddr

type Output = VAddr

The resulting type after applying the | operator.

fn bitor(self, rhs: VAddr) -> VAddr

Performs the | operation.

impl BitOr<u64> for VAddr

type Output = VAddr

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<usize> for VAddr

type Output = VAddr

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for VAddr

fn clone(&self) -> VAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VAddr

impl Debug for VAddr

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

Formats the value using the given formatter.

impl Display for VAddr

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

Formats the value using the given formatter.

impl Eq for VAddr

impl From<i32> for VAddr

fn from(num: i32) -> Self

Performs the conversion.

impl From<u64> for VAddr

fn from(num: u64) -> Self

Performs the conversion.

impl From<usize> for VAddr

fn from(num: usize) -> Self

Performs the conversion.

impl Into<u64> for VAddr

fn into(self) -> u64

Performs the conversion.

impl Into<usize> for VAddr

fn into(self) -> usize

Performs the conversion.

impl LowerHex for VAddr

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

Formats the value using the given formatter.

impl Octal for VAddr

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

Formats the value using the given formatter.

impl Ord for VAddr

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<VAddr> for VAddr

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<VAddr> for VAddr

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Pointer for VAddr

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

Formats the value using the given formatter.

impl Rem<VAddr> for VAddr

type Output = VAddr

The resulting type after applying the % operator.

fn rem(self, rhs: VAddr) -> Self::Output

Performs the % operation.

impl Rem<u64> for VAddr

type Output = u64

The resulting type after applying the % operator.

fn rem(self, rhs: Self::Output) -> Self::Output

Performs the % operation.

impl Rem<usize> for VAddr

type Output = usize

The resulting type after applying the % operator.

fn rem(self, rhs: Self::Output) -> Self::Output

Performs the % operation.

impl Shr<i32> for VAddr

type Output = u64

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u64> for VAddr

type Output = u64

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<usize> for VAddr

type Output = u64

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl StructuralEq for VAddr

impl StructuralPartialEq for VAddr

impl Sub<VAddr> for VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u64> for VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl UpperHex for VAddr

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

Formats the value using the given formatter.