Struct VAddr

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

Implementations

impl VAddr

pub fn from_usize_checked(u: usize) -> Result<Self, InvalidAddress>

pub const unsafe fn from_usize_unchecked(u: usize) -> Self

Constructs a VAddr from an arbitrary usize value without checking if it’s valid.

Pros of this function:

• can be used in const-eval contexts

Cons of this function:

• “refer to ‘Safety’ section”

Safety

u can use dis function to construct invalid addresses. probably dont do that.

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

Constructs a VAddr from a *const T pointer, exposing its provenance.

pub fn of<T: ?Sized>(pointee: &T) -> Self

impl VAddr

pub const fn zero() -> Self

pub fn from_u64(u: u64) -> Self

Panics

• If debug assertions are enabled and the address is not valid for the target architecture.

pub fn align_up<A: Into<usize>>(self, align: A) -> Self

Aligns self up to align.

The specified alignment must be a power of two.

Panics

• If align is not a power of two.
• If debug assertions are enabled and the aligned address is not valid for the target architecture.

pub fn align_down<A: Into<usize>>(self, align: A) -> Self

Aligns self down to align.

The specified alignment must be a power of two.

Panics

• If align is not a power of two.
• If debug assertions are enabled and the aligned address is not valid for the target architecture.

pub fn offset(self, offset: isize) -> Self

Offsets this address by offset bytes.

If the specified offset would overflow, this function saturates instead.

pub fn difference(self, other: Self) -> isize

Returns the difference between self and other.

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

Returns true if self is aligned on the specified alignment.

pub fn is_aligned_for<T>(self) -> bool

Returns true if self is aligned on the alignment of the specified type.

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

Converts this address into a const pointer to a value of type T.

Panics

• If self is not aligned for a T-typed value.

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

Converts this address into a mutable pointer to a value of type T.

Panics

• If self is not aligned for a T-typed value.

pub fn as_non_null<T>(self) -> Option<NonNull<T>>

Converts this address into a Option<NonNull<T>> from a VAddr, returning None if the address is null.

Panics

• If self is not aligned for a T-typed value.

Trait Implementations

impl Add<usize> for VAddr

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

Offset self up by rhs.

Notes

• The address will be offset by the minimum addressable unit of the target architecture (i.e. probably bytes), not by by units of a Rust type like {*const T, *mut T}::add.
• Therefore, resulting address may have a different alignment from the input address.

Panics

• If the resulting address is invalid.

type Output = VAddr

The resulting type after applying the + operator.

impl Add for VAddr

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

Add rhs bytes to this this address.

Note that the resulting address may differ in alignment from the input address!

type Output = VAddr

The resulting type after applying the + operator.

impl AddAssign<usize> for VAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl AddAssign for VAddr

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Address for VAddr

fn from_usize(u: usize) -> Self

Panics

• If debug assertions are enabled and the address is not valid for the target architecture.

fn as_usize(self) -> usize

fn align_up<A: Into<usize>>(self, align: A) -> Self

Aligns self up to align.

fn align_up_for<T>(self) -> Self

Align self up to the required alignment for a value of type T.

fn align_down<A: Into<usize>>(self, align: A) -> Self

Aligns self down to align.

fn align_down_for<T>(self) -> Self

Align self down to the required alignment for a value of type T.

fn offset(self, offset: isize) -> Self

Offsets this address by offset bytes.

fn difference(self, other: Self) -> isize

Returns the difference between self and other.

fn is_aligned<A: Into<usize>>(self, align: A) -> bool

Returns true if self is aligned on the specified alignment.

fn is_aligned_for<T>(self) -> bool

Returns true if self is aligned on the alignment of the specified type.

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

Converts this address into a const pointer to a value of type T.

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

Converts this address into a mutable pointer to a value of type T.

fn as_non_null<T>(self) -> Option<NonNull<T>>

Converts this address into a Option<NonNull<T>> from a VAddr, returning None if the address is null.

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

Restrict a value to a certain interval.

impl PartialEq for VAddr

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

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 VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for VAddr

type Output = VAddr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for VAddr

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl SubAssign for VAddr

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for VAddr

impl Eq for VAddr

impl StructuralPartialEq for VAddr