Struct hal::memory::VAddr

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

Represents a virtual address. On architectures that have extra requirements for canonical virtual addresses (e.g. x86_64 requiring correct sign-extension in high bits), these requirements are always enforced.

Implementations

impl VAddr

pub const fn new(address: usize) -> VAddr

Construct a new VAddr. This will canonicalise the given value.

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

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

pub const fn canonicalise(self) -> VAddr

Canonicalise this virtual address. On this architecture, there are no extra requirements, and so we just return the address as is.

pub fn align_down(self, align: usize) -> VAddr

Align this address to the given alignment, moving downwards if this is not already aligned. align must be 0 or a power-of-two.

pub fn align_up(self, align: usize) -> VAddr

Align this address to the given alignment, moving upwards if this is not already aligned. align must be 0 or a power-of-two.

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

pub fn checked_add(self, rhs: usize) -> Option<Self>

pub fn checked_sub(self, rhs: usize) -> Option<Self>

Trait Implementations

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<usize> for VAddr

fn add_assign(&mut self, rhs: usize)

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 Debug for VAddr

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

Formats the value using the given formatter.

impl Default for VAddr

fn default() -> VAddr

Returns the “default value” for a type.

impl<T> From<*const T> for VAddr

fn from(ptr: *const T) -> VAddr

Converts to this type from the input type.

impl<T> From<*mut T> for VAddr

fn from(ptr: *mut T) -> VAddr

Converts to this type from the input type.

impl From<VAddr> for usize

fn from(address: VAddr) -> usize

Converts to this type from the input type.

impl LowerHex 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.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &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 VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for VAddr

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl UpperHex for VAddr

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

Formats the value using the given formatter.

impl Copy for VAddr

impl Eq for VAddr

impl StructuralPartialEq for VAddr