Struct mycelium_kernel::arch::mm::page::Page

#[repr(C)]
pub struct Page<A, S>
where
    S: Size,
{ /* private fields */ }

A memory page.

Implementations

impl<A, S> Page<A, S>

where A: Address, S: StaticSize,

pub fn starting_at_fixed( addr: impl Into<A> ) -> Result<Page<A, S>, NotAligned<S>>

Returns a page starting at the given address.

pub fn containing_fixed(addr: impl Into<A>) -> Page<A, S>

Returns the page that contains the given address.

impl<A, S> Page<A, S>

where A: Address, S: Size,

pub fn starting_at( addr: impl Into<A>, size: S ) -> Result<Page<A, S>, NotAligned<S>>

Returns a page starting at the given address.

pub fn containing(addr: impl Into<A>, size: S) -> Page<A, S>

Returns the page that contains the given address.

pub fn base_addr(&self) -> A

pub fn end_addr(&self) -> A

Returns the last address in the page, exclusive.

The returned address will be the base address of the next page.

pub fn size(&self) -> S

pub fn contains(&self, addr: impl Into<A>) -> bool

pub fn range_inclusive(self, end: Page<A, S>) -> PageRange<A, S>

pub fn range_to(self, end: Page<A, S>) -> PageRange<A, S>

pub unsafe fn as_slice(&self) -> &[u8]

Returns the entire contents of the page as a slice.

Safety

When calling this method, ensure that the page will not be mutated concurrently, including by user code.

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8]

Returns the entire contents of the page as a mutable slice.

Safety

When calling this method, ensure that the page will not be read or mutated concurrently, including by user code.

Trait Implementations

impl<A, S> Add<usize> for Page<A, S>

where A: Address, S: Size,

type Output = Page<A, S>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<A, S> Clone for Page<A, S>

where A: Clone, S: Clone + Size,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A, S> Debug for Page<A, S>

where A: Debug, S: Size + Display,

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

Formats the value using the given formatter.

impl<'a, L, S> Index<&'a Page<VAddr, S>> for PageTable<L>

where L: Level, S: Size,

type Output = Entry<L>

The returned type after indexing.

fn index( &self, pg: &'a Page<VAddr, S> ) -> &<PageTable<L> as Index<&'a Page<VAddr, S>>>::Output

Performs the indexing (container[index]) operation.

impl<L, S> Index<Page<VAddr, S>> for PageTable<L>

where L: Level, S: Size,

type Output = Entry<L>

The returned type after indexing.

fn index( &self, page: Page<VAddr, S> ) -> &<PageTable<L> as Index<Page<VAddr, S>>>::Output

Performs the indexing (container[index]) operation.

impl<'a, L, S> IndexMut<&'a Page<VAddr, S>> for PageTable<L>

where L: Level + HoldsSize<S>, S: Size,

fn index_mut( &mut self, pg: &'a Page<VAddr, S> ) -> &mut <PageTable<L> as Index<&'a Page<VAddr, S>>>::Output

Performs the mutable indexing (container[index]) operation.

impl<L, S> IndexMut<Page<VAddr, S>> for PageTable<L>

where L: Level, S: Size,

fn index_mut( &mut self, page: Page<VAddr, S> ) -> &mut <PageTable<L> as Index<Page<VAddr, S>>>::Output

Performs the mutable indexing (container[index]) operation.

impl<A, S> Ord for Page<A, S>

where A: Address, S: StaticSize,

fn cmp(&self, other: &Page<A, 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 + PartialOrd,

Restrict a value to a certain interval.

impl<A, S> PartialEq for Page<A, S>

where A: PartialEq, S: PartialEq + Size,

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

where A: Address, S: Size,

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

where A: Address, S: Size,

type Output = Page<A, S>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<A, S> Copy for Page<A, S>

where A: Copy, S: Copy + Size,

impl<A, S> Eq for Page<A, S>

where A: Eq, S: Eq + Size,

impl<A, S> StructuralEq for Page<A, S>

where S: Size,

impl<A, S> StructuralPartialEq for Page<A, S>

where S: Size,