Struct Page 

#[repr(C)]
pub struct Page<S = Size4KiB>
where
    S: PageSize,
{
    start_address: VirtAddr,
    size: PhantomData<S>,
}

A virtual memory page.

Fields

start_address: VirtAddr

size: PhantomData<S>

Implementations

impl<S> Page<S>

where S: PageSize,

pub const SIZE: u64 = S::SIZE

The page size in bytes.

pub const fn from_start_address( address: VirtAddr, ) -> Result<Page<S>, AddressNotAligned>

Returns the page that starts at the given virtual address.

Returns an error if the address is not correctly aligned (i.e. is not a valid page start).

pub const unsafe fn from_start_address_unchecked( start_address: VirtAddr, ) -> Page<S>

Returns the page that starts at the given virtual address.

Safety

The address must be correctly aligned.

pub const fn containing_address(address: VirtAddr) -> Page<S>

Returns the page that contains the given virtual address.

pub const fn start_address(self) -> VirtAddr

Returns the start address of the page.

pub const fn size(self) -> u64

Returns the size the page (4KB, 2MB or 1GB).

pub const fn p4_index(self) -> PageTableIndex

Returns the level 4 page table index of this page.

pub const fn p3_index(self) -> PageTableIndex

Returns the level 3 page table index of this page.

pub const fn page_table_index(self, level: PageTableLevel) -> PageTableIndex

Returns the table index of this page at the specified level.

pub const fn range(start: Page<S>, end: Page<S>) -> PageRange<S>

Returns a range of pages, exclusive end.

pub const fn range_inclusive( start: Page<S>, end: Page<S>, ) -> PageRangeInclusive<S>

Returns a range of pages, inclusive end.

impl<S> Page<S>

where S: NotGiantPageSize,

pub const fn p2_index(self) -> PageTableIndex

Returns the level 2 page table index of this page.

impl Page<Size1GiB>

pub const fn from_page_table_indices_1gib( p4_index: PageTableIndex, p3_index: PageTableIndex, ) -> Page<Size1GiB>

Returns the 1GiB memory page with the specified page table indices.

impl Page<Size2MiB>

pub const fn from_page_table_indices_2mib( p4_index: PageTableIndex, p3_index: PageTableIndex, p2_index: PageTableIndex, ) -> Page<Size2MiB>

Returns the 2MiB memory page with the specified page table indices.

impl Page

pub const fn from_page_table_indices( p4_index: PageTableIndex, p3_index: PageTableIndex, p2_index: PageTableIndex, p1_index: PageTableIndex, ) -> Page

Returns the 4KiB memory page with the specified page table indices.

pub const fn p1_index(self) -> PageTableIndex

Returns the level 1 page table index of this page.

Trait Implementations

impl<S> Add<u64> for Page<S>

where S: PageSize,

type Output = Page<S>

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <Page<S> as Add<u64>>::Output

Performs the + operation.

impl<S> AddAssign<u64> for Page<S>

where S: PageSize,

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl<S> Clone for Page<S>

where S: Clone + PageSize,

fn clone(&self) -> Page<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Copy for Page<S>

where S: Copy + PageSize,

impl<S> Debug for Page<S>

where S: PageSize,

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

Formats the value using the given formatter.

impl<S> Eq for Page<S>

where S: Eq + PageSize,

impl<S> Hash for Page<S>

where S: Hash + PageSize,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S> Ord for Page<S>

where S: Ord + PageSize,

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

where S: PartialEq + PageSize,

fn eq(&self, other: &Page<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S> PartialOrd for Page<S>

where S: PartialOrd + PageSize,

fn partial_cmp(&self, other: &Page<S>) -> 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<S> Step for Page<S>

where S: PageSize,

Available on crate feature step_trait only.

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

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

Returns the bounds on the number of successor steps required to get from start to end like Iterator::size_hint().

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

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

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

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

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

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

fn forward_overflowing(start: Page<S>, count: usize) -> (Page<S>, bool)

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

Returns the value that would be obtained by taking the successor of self count times along with a boolean tracking whether overflow occurred.

fn backward_overflowing(start: Page<S>, count: usize) -> (Page<S>, bool)

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

Returns the value that would be obtained by taking the successor of self count times along with a boolean tracking whether overflow occurred.

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

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

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. (step_trait)

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)

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. (step_trait)

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

impl<S> StructuralPartialEq for Page<S>

where S: PartialEq + PageSize,

impl<S> Sub for Page<S>

where S: PageSize,

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: Page<S>) -> <Page<S> as Sub>::Output

Performs the - operation.

impl<S> Sub<u64> for Page<S>

where S: PageSize,

type Output = Page<S>

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <Page<S> as Sub<u64>>::Output

Performs the - operation.

impl<S> SubAssign<u64> for Page<S>

where S: PageSize,

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.