Struct RawFrame 

pub struct RawFrame { /* private fields */ }

A physical memory frame.

Implementations

impl RawFrame

pub const fn new(addr: usize) -> Self

Creates a new RawFrame with the given address.

Panics

If addr is not aligned to a multiple of PAGE_SIZE.

Examples

use kernel_api::memory::{RawFrame, PAGE_SIZE};

let frame = RawFrame::new(PAGE_SIZE * 5);

Creating a misaligned frame will panic:

use kernel_api::memory::RawFrame;

let frame = RawFrame::new(3);

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

Checked integer subtraction.

Computes the frame count frames below self, returning None if overflow occurred.

Examples

use kernel_api::memory::{RawFrame, PAGE_SIZE};

let frame = RawFrame::new(PAGE_SIZE * 2);
assert_eq!(frame.checked_sub(1), Some(RawFrame::new(PAGE_SIZE)));
assert_eq!(frame.checked_sub(5), None);

Trait Implementations

impl Add<isize> for RawFrame

Offsets the RawFrame by rhs frames.

type Output = RawFrame

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for RawFrame

Offsets the RawFrame by rhs frames.

type Output = RawFrame

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for RawFrame

fn clone(&self) -> RawFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RawFrame

impl Debug for RawFrame

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

Formats the value using the given formatter.

impl Deref for RawFrame

type Target = PhysicalAddress

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for RawFrame

impl From<RawFrame> for PhysicalAddress

fn from(value: RawFrame) -> Self

Converts to this type from the input type.

impl Hash for RawFrame

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

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 LowerHex for RawFrame

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

Formats the value using the given formatter.

impl Ord for RawFrame

fn cmp(&self, other: &RawFrame) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for RawFrame

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RawFrame

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

fn steps_between(start: &Self, end: &Self) -> (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()][Iterator::size_hint()].

fn forward_checked(start: Self, count: usize) -> Option<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 forward_overflowing(start: Self, count: usize) -> (Self, 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_checked(start: Self, count: usize) -> Option<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.

fn backward_overflowing(start: Self, count: usize) -> (Self, 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 StructuralPartialEq for RawFrame

impl Sub for RawFrame

Returns the number of frames between self and rhs.

type Output = usize

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for RawFrame

Offsets the RawFrame by rhs frames.

type Output = RawFrame

The resulting type after applying the - operator.

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

Performs the - operation.