Struct x86_64::structures::paging::page::Page[][src]

#[repr(C)]
pub struct Page<S: PageSize = Size4KiB> { /* fields omitted */ }
Expand description

A virtual memory page.

Implementations

impl<S: PageSize> Page<S>[src]

pub const SIZE: u64[src]

The page size in bytes.

pub fn from_start_address(address: VirtAddr) -> Result<Self, AddressNotAligned>[src]

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
) -> Self
[src]

Returns the page that starts at the given virtual address.

Safety

The address must be correctly aligned.

pub fn containing_address(address: VirtAddr) -> Self[src]

Returns the page that contains the given virtual address.

pub const fn start_address(self) -> VirtAddr[src]

Returns the start address of the page.

pub const fn size(self) -> u64[src]

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

pub const fn p4_index(self) -> PageTableIndex[src]

Returns the level 4 page table index of this page.

pub const fn p3_index(self) -> PageTableIndex[src]

Returns the level 3 page table index of this page.

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

Notable traits for PageRange<S>

impl<S: PageSize> Iterator for PageRange<S> type Item = Page<S>;
[src]

Returns a range of pages, exclusive end.

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

Notable traits for PageRangeInclusive<S>

impl<S: PageSize> Iterator for PageRangeInclusive<S> type Item = Page<S>;
[src]

Returns a range of pages, inclusive end.

impl<S: NotGiantPageSize> Page<S>[src]

pub const fn p2_index(self) -> PageTableIndex[src]

Returns the level 2 page table index of this page.

impl Page<Size1GiB>[src]

pub fn from_page_table_indices_1gib(
    p4_index: PageTableIndex,
    p3_index: PageTableIndex
) -> Self
[src]

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

impl Page<Size2MiB>[src]

pub fn from_page_table_indices_2mib(
    p4_index: PageTableIndex,
    p3_index: PageTableIndex,
    p2_index: PageTableIndex
) -> Self
[src]

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

impl Page<Size4KiB>[src]

pub fn from_page_table_indices(
    p4_index: PageTableIndex,
    p3_index: PageTableIndex,
    p2_index: PageTableIndex,
    p1_index: PageTableIndex
) -> Self
[src]

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

pub const fn p1_index(self) -> PageTableIndex[src]

Returns the level 1 page table index of this page.

Trait Implementations

impl<S: PageSize> Add<u64> for Page<S>[src]

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output[src]

Performs the + operation. Read more

impl<S: PageSize> AddAssign<u64> for Page<S>[src]

fn add_assign(&mut self, rhs: u64)[src]

Performs the += operation. Read more

impl<S: Clone + PageSize> Clone for Page<S>[src]

fn clone(&self) -> Page<S>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<S: PageSize> Debug for Page<S>[src]

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

Formats the value using the given formatter. Read more

impl<S: Ord + PageSize> Ord for Page<S>[src]

fn cmp(&self, other: &Page<S>) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl<S: PartialEq + PageSize> PartialEq<Page<S>> for Page<S>[src]

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

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

fn ne(&self, other: &Page<S>) -> bool[src]

This method tests for !=.

impl<S: PartialOrd + PageSize> PartialOrd<Page<S>> for Page<S>[src]

fn partial_cmp(&self, other: &Page<S>) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl<S: PageSize> Sub<Page<S>> for Page<S>[src]

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output[src]

Performs the - operation. Read more

impl<S: PageSize> Sub<u64> for Page<S>[src]

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output[src]

Performs the - operation. Read more

impl<S: PageSize> SubAssign<u64> for Page<S>[src]

fn sub_assign(&mut self, rhs: u64)[src]

Performs the -= operation. Read more

impl<S: Copy + PageSize> Copy for Page<S>[src]

impl<S: Eq + PageSize> Eq for Page<S>[src]

impl<S: PageSize> StructuralEq for Page<S>[src]

impl<S: PageSize> StructuralPartialEq for Page<S>[src]

Auto Trait Implementations

impl<S> Send for Page<S> where
    S: Send

impl<S> Sync for Page<S> where
    S: Sync

impl<S> Unpin for Page<S> where
    S: Unpin

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.