Struct Va 

#[repr(transparent)]
pub struct Va(usize);

Represents a virtual address.

The Va (Virtual Address) struct represents an address in the virtual memory space used by the kernel or user-space applications.

This abstraction provides utility methods for validation, alignment, and address manipulation, ensuring safe and consistent handling of virtual addresses.

Tuple Fields

0: usize

Implementations

impl Va

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

Creates a new virtual address if the address is valid.

This method checks whether the given address falls within the valid virtual address range. If it does, a Some(Va) is returned; otherwise, None is returned.

Arguments

• addr: A usize representing the virtual address.

Returns

• Some(Va): If the address is within the valid virtual memory range.
• None: If the address is invalid.

Example

let va = Va::new(0xFFFF_8000_1234_5678);
assert!(va.is_some()); // Valid virtual address

let invalid_va = Va::new(0xFFFF_7000_1234_5678);
assert!(invalid_va.is_none()); // Invalid virtual address

pub const fn into_usize(self) -> usize

Returns the raw usize representation of the virtual address.

This method allows extracting the underlying usize value, enabling low-level operations or conversions between address types.

Returns

• The virtual address as a usize.

Example

let va = Va::new(0xFFFF_8000_1234_5678).unwrap();
let raw_addr = va.into_usize();
assert_eq!(raw_addr, 0xFFFF_8000_1234_5678);

pub const fn page_down(self) -> Self

Aligns the virtual address down to the nearest page boundary.

This method ensures that the address is aligned to the start of its memory page by clearing the lower bits that represent the page offset.

Returns

• A new Va instance representing the aligned address.

Example

let va = Va::new(0xFFFF_8000_1234_5678).unwrap();
let aligned = va.page_down();
assert_eq!(aligned.into_usize(), 0xFFFF_8000_1234_5000); // Example alignment

pub const fn page_up(self) -> Self

Aligns the virtual address up to the nearest page boundary.

This method rounds up the address to the next memory page.

Returns

• A new Va instance representing the aligned address.

Example

let va = Va::new(0xFFFF_8000_1234_5678).unwrap();
let aligned = va.page_up();
assert_eq!(aligned.into_usize(), 0xFFFF_8000_1234_6000); // Example alignment

pub const fn offset(self) -> usize

Extracts the offset within the memory page from the virtual address.

This method retrieves the lower bits of the address that indicate the position within a page, which is useful for memory management and page-related operations.

Returns

• The offset within the page as a usize.

Example

let va = Va::new(0xFFFF_8000_1234_5678).unwrap();
let offset = va.offset();
assert_eq!(offset, 0x678); // Example offset within the page

Trait Implementations

impl Add<usize> for Va

type Output = Va

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for Va

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl BitAnd<usize> for Va

type Output = Va

The resulting type after applying the & operator.

fn bitand(self, other: usize) -> Self

Performs the & operation.

impl BitAndAssign<usize> for Va

fn bitand_assign(&mut self, other: usize)

Performs the &= operation.

impl BitOr<usize> for Va

type Output = Va

The resulting type after applying the | operator.

fn bitor(self, other: usize) -> Self

Performs the | operation.

impl BitOrAssign<usize> for Va

fn bitor_assign(&mut self, other: usize)

Performs the |= operation.

impl Clone for Va

fn clone(&self) -> Va

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Va

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

Formats the value using the given formatter.

impl Display for Va

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

Formats the value using the given formatter.

impl Ord for Va

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

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

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

type Output = Va

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Va

type Output = usize

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl SubAssign<usize> for Va

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl Copy for Va

impl Eq for Va

impl StructuralPartialEq for Va