Struct sunrise_kernel::mem::VirtualAddress

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

Represents a Virtual address

Implementations

impl VirtualAddress

pub const fn addr(self) -> usize

Gets the address as a usize.

impl VirtualAddress

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

Tries to add an offset to a VirtualAddress, returning None if this would cause an overflow.

This function does not return a KernelError, as it does not know whether the address or the size is the cause of the error.

pub fn check_aligned_to(self, alignment: usize) -> Result<(), KernelError>

Checks that this address meets the given alignment.

Errors

• InvalidAddress: self is not aligned to alignment.

pub fn floor(self) -> VirtualAddress

Rounds down to PAGE_SIZE.

pub fn ceil(self) -> VirtualAddress

Rounds up PAGE_SIZE.

Trait Implementations

impl Add<VirtualAddress> for usize

type Output = VirtualAddress

The resulting type after applying the + operator.

fn add(self, other: VirtualAddress) -> VirtualAddress

Adding a length to an address gives another address

impl Add<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the + operator.

fn add(self, other: usize) -> VirtualAddress

Adding a length to an address gives another address

impl AddAssign<usize> for VirtualAddress

fn add_assign(&mut self, rhs: usize)

Adding a length to an address gives another address

impl Clone for VirtualAddress

fn clone(&self) -> VirtualAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VirtualAddress

impl Debug for VirtualAddress

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

Formats the value using the given formatter.

impl Display for VirtualAddress

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

Formats the value using the given formatter.

impl Eq for VirtualAddress

impl Hash for VirtualAddress

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for VirtualAddress

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

Formats the value using the given formatter.

impl Ord for VirtualAddress

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

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

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

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

This method tests for !=.

impl PartialOrd<VirtualAddress> for VirtualAddress

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

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

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

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

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

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

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

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

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

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

impl Step for VirtualAddress

fn steps_between(start: &Self, end: &Self) -> Option<usize>

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

recently redesigned

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, count: usize) -> Option<Self>

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

recently added

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, count: usize) -> Option<Self>

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

recently added

Returns the value that would be obtained by taking the successor of self count times.

fn forward(start: Self, count: usize) -> Self

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

recently added

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

niche optimization path

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

recently added

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

niche optimization path

Returns the value that would be obtained by taking the predecessor of self count times.

impl StructuralEq for VirtualAddress

impl StructuralPartialEq for VirtualAddress

impl Sub<VirtualAddress> for VirtualAddress

type Output = usize

The resulting type after applying the - operator.

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

Subtracting two address gives their distance

impl Sub<usize> for VirtualAddress

type Output = VirtualAddress

The resulting type after applying the - operator.

fn sub(self, other: usize) -> VirtualAddress

Subtracting a length from an address gives another address

impl SubAssign<usize> for VirtualAddress

fn sub_assign(&mut self, rhs: usize)

Subtracting a length from an address gives another address