Struct Frame

#[repr(transparent)]
pub struct Frame {
    base: PhysicalAddress<PAGE_SIZE>,
}

A memory frame

Fields

base: PhysicalAddress<PAGE_SIZE>

Implementations

impl Frame

pub const fn to_page(&self) -> Page

🔬This is a nightly-only experimental API. (kernel_physical_page_offset #1)

Converts a Frame into a Page via the physical page map region

pub const fn zero() -> Frame

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

Returns the zero frame

pub const fn new(base: PhysicalAddress<PAGE_SIZE>) -> Self

Creates a Frame using base as the first address within it

pub const fn checked_sub(&self, rhs: usize) -> Option<Self>

Attempts to subtract rhs number of pages, returning None if overflow would occur

pub const fn start(&self) -> PhysicalAddress<PAGE_SIZE>

Returns the first address within the Frame

pub const fn end(&self) -> PhysicalAddress<PAGE_SIZE>

Returns the address one after the end of the Frame

Trait Implementations

impl Add<isize> for Frame

type Output = Frame

The resulting type after applying the + operator.

fn add(self, rhs: isize) -> Self::Output

Performs the + operation.

impl Add<usize> for Frame

type Output = Frame

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Ord for Frame

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Frame

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

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

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

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

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

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

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 #42168)

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 #42168)

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 #42168)

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 #42168)

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 #42168)

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

impl Sub<isize> for Frame

type Output = Frame

The resulting type after applying the - operator.

fn sub(self, rhs: isize) -> Self::Output

Performs the - operation.

impl Sub<usize> for Frame

type Output = Frame

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl Sub for Frame

type Output = usize

The resulting type after applying the - operator.

fn sub(self, rhs: Frame) -> Self::Output

Performs the - operation.

impl Address for Frame

Available on non-crate feature use_std only.

impl Copy for Frame

impl Eq for Frame

impl Sealed for Frame

Available on non-crate feature use_std only.

impl StructuralPartialEq for Frame