Struct memory_structs::Page

pub struct Page<P: PageSize = Page4K> { /* private fields */ }

A Page is a chunk of virtual memory aligned to a page boundary (default 4KiB) given by the P parameter.

Implementations

impl Page<Page4K>

pub const fn containing_address(addr: VirtualAddress) -> Page

Returns the 4KiB Page containing the given VirtualAddress.

pub const fn align_up(&self, alignment_4k_pages: usize) -> Page

Returns a new Page that is aligned up from this Page to the nearest multiple of alignment_4k_pages.

pub const fn from_4k_into_generic<P: PageSize>(self) -> Page<P>

Converts a known 4K-sized Page into a Page<P> with a generic PageSize parameter.

impl Page<Page2M>

pub const fn containing_address_2mb(addr: VirtualAddress) -> Page<Page2M>

Returns the 2MiB huge Page containing the given VirtualAddress.

pub const fn from_2m_into_generic<P: PageSize>(self) -> Page<P>

Converts a known 2M-sized Page into a Page<P> with a generic PageSize parameter.

impl Page<Page1G>

pub const fn containing_address_1gb(addr: VirtualAddress) -> Page<Page1G>

Returns the 1GiB huge Page containing the given VirtualAddress.

pub const fn from_1g_into_generic<P: PageSize>(self) -> Page<P>

Converts a known 1G-sized Page into a Page<P> with a generic PageSize parameter.

impl<P: PageSize> Page<P>

pub const MIN: Page<P> = _

The minimum (smallest) valid value a Page can have.

pub const MAX: Page<P> = _

The maximum (largest) valid value a Page can have.

pub const fn number(&self) -> usize

Returns the 4K-sized number of this Page.

pub const fn start_address(&self) -> VirtualAddress

Returns the VirtualAddress at the start of this Page.

pub const fn page_size(&self) -> MemChunkSize

Returns the size of this Page.

impl<P: PageSize> Page<P>

pub const fn p4_index(&self) -> usize

Returns the 9-bit part of this Page’s VirtualAddress that is the index into the P4 page table entries list.

pub const fn p3_index(&self) -> usize

Returns the 9-bit part of this Page’s VirtualAddress that is the index into the P3 page table entries list.

pub const fn p2_index(&self) -> usize

Returns the 9-bit part of this Page’s VirtualAddress that is the index into the P2 page table entries list.

pub const fn p1_index(&self) -> usize

Returns the 9-bit part of this Page’s VirtualAddress that is the index into the P1 page table entries list.

Using this returned usize value as an index into the P1 entries list will give you the final PTE, from which you can extract the mapped Frame using PageTableEntry::pointed_frame().

Trait Implementations

impl<P: PageSize> Add<usize> for Page<P>

type Output = Page<P>

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Page<P>

Performs the + operation.

impl<P: PageSize> AddAssign<usize> for Page<P>

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl<P: Clone + PageSize> Clone for Page<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: PageSize> Debug for Page<P>

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

Formats the value using the given formatter.

impl From<Page<Page1G>> for Page<Page4K>

fn from(p: Page<Page1G>) -> Self

Converts to this type from the input type.

impl From<Page<Page2M>> for Page<Page4K>

fn from(p: Page<Page2M>) -> Self

Converts to this type from the input type.

impl<P: Ord + PageSize> Ord for Page<P>

fn cmp(&self, other: &Page<P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<P: PartialEq + PageSize> PartialEq<Page<P>> for Page<P>

fn eq(&self, other: &Page<P>) -> 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<P: PartialOrd + PageSize> PartialOrd<Page<P>> for Page<P>

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

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

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

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

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

🔬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<P>, count: usize) -> Option<Page<P>>

🔬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(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<P: PageSize> Sub<usize> for Page<P>

type Output = Page<P>

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Page<P>

Performs the - operation.

impl<P: PageSize> SubAssign<usize> for Page<P>

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl TryFrom<Page<Page4K>> for Page<Page1G>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(p: Page) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<Page<Page4K>> for Page<Page2M>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(p: Page) -> Result<Self, &'static str>

Performs the conversion.

impl<P: Copy + PageSize> Copy for Page<P>

impl<P: Eq + PageSize> Eq for Page<P>

impl<P: PageSize> StructuralEq for Page<P>

impl<P: PageSize> StructuralPartialEq for Page<P>