Struct x86_64::structures::paging::frame::PhysFrame

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

A physical memory frame.

Implementations

impl<S: PageSize> PhysFrame<S>

pub fn from_start_address(address: PhysAddr) -> Result<Self, AddressNotAligned>

Returns the frame that starts at the given virtual address.

Returns an error if the address is not correctly aligned (i.e. is not a valid frame start).

pub const unsafe fn from_start_address_unchecked(
    start_address: PhysAddr
) -> Self

Returns the frame that starts at the given virtual address.

Safety

The address must be correctly aligned.

pub fn containing_address(address: PhysAddr) -> Self

Returns the frame that contains the given physical address.

pub const fn start_address(self) -> PhysAddr

Returns the start address of the frame.

pub const fn size(self) -> u64

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

pub const fn range(start: PhysFrame<S>, end: PhysFrame<S>) -> PhysFrameRange<S>

Returns a range of frames, exclusive end.

pub const fn range_inclusive(
    start: PhysFrame<S>,
    end: PhysFrame<S>
) -> PhysFrameRangeInclusive<S>

Returns a range of frames, inclusive end.

Trait Implementations

impl<S: PageSize> Add<u64> for PhysFrame<S>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S: PageSize> AddAssign<u64> for PhysFrame<S>

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl<S: Clone + PageSize> Clone for PhysFrame<S>

fn clone(&self) -> PhysFrame<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: PageSize> Debug for PhysFrame<S>

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

Formats the value using the given formatter.

impl<S: Ord + PageSize> Ord for PhysFrame<S>

fn cmp(&self, other: &PhysFrame<S>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<S: PartialEq + PageSize> PartialEq<PhysFrame<S>> for PhysFrame<S>

fn eq(&self, other: &PhysFrame<S>) -> bool

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

fn ne(&self, other: &PhysFrame<S>) -> bool

This method tests for !=.

impl<S: PartialOrd + PageSize> PartialOrd<PhysFrame<S>> for PhysFrame<S>

fn partial_cmp(&self, other: &PhysFrame<S>) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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<S: PageSize> Sub<PhysFrame<S>> for PhysFrame<S>

type Output = u64

The resulting type after applying the - operator.

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

Performs the - operation.

impl<S: PageSize> Sub<u64> for PhysFrame<S>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<S: PageSize> SubAssign<u64> for PhysFrame<S>

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl<S: Copy + PageSize> Copy for PhysFrame<S>

impl<S: Eq + PageSize> Eq for PhysFrame<S>

impl<S: PageSize> StructuralEq for PhysFrame<S>

impl<S: PageSize> StructuralPartialEq for PhysFrame<S>