Struct PhysFrame 

#[repr(C)]
pub struct PhysFrame<S = Size4KiB>
where
    S: PageSize,
{
    pub(crate) start_address: PhysAddr,
    size: PhantomData<S>,
}

A physical memory frame.

Fields

start_address: PhysAddr

size: PhantomData<S>

Implementations

impl<S> PhysFrame<S>

where S: PageSize,

pub const fn from_start_address( address: PhysAddr, ) -> Result<PhysFrame<S>, 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, ) -> PhysFrame<S>

Returns the frame that starts at the given virtual address.

Safety

The address must be correctly aligned.

pub const fn from_pfn(pfn: u64) -> PhysFrame<S>

Returns the frame by a physical frame number.

use x86_64::{PhysAddr, structures::paging::{PhysFrame, Size4KiB}};

assert_eq!(PhysFrame::<Size4KiB>::from_pfn(0x123), PhysFrame::<Size4KiB>::containing_address(PhysAddr::new(0x123000)));

Panics

This function will panic if the resulting address is not valid.

pub const fn try_from_pfn(pfn: u64) -> Result<PhysFrame<S>, PfnNotValid>

Returns the frame by a physical frame number.

use x86_64::{PhysAddr, structures::paging::{PhysFrame, Size4KiB}};

assert_eq!(PhysFrame::<Size4KiB>::try_from_pfn(0x123), Ok(PhysFrame::<Size4KiB>::containing_address(PhysAddr::new(0x123000))));

Error

This function will return an error if the resulting address is not valid.

pub const unsafe fn from_pfn_unchecked(pfn: u64) -> PhysFrame<S>

Returns the frame by a physical frame number.

Safety

The resulting address must be valid.

pub const fn containing_address(address: PhysAddr) -> PhysFrame<S>

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 pfn(self) -> u64

Returns the PFN of the current frame.

The PFN is defined to be the address divided by the page size.

use x86_64::{PhysAddr, structures::paging::{PhysFrame, Size1GiB, Size2MiB, Size4KiB}};

assert_eq!(PhysFrame::<Size4KiB>::containing_address(PhysAddr::new(0x123000)).pfn(), 0x123);

// Note that this means that the PFN for the same address will be
// different for different page sizes.
assert_eq!(PhysFrame::<Size4KiB>::containing_address(PhysAddr::new(0xC000_0000)).pfn(), 0xC0000);
assert_eq!(PhysFrame::<Size2MiB>::containing_address(PhysAddr::new(0xC000_0000)).pfn(), 0x600);
assert_eq!(PhysFrame::<Size1GiB>::containing_address(PhysAddr::new(0xC000_0000)).pfn(), 0x3);

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> Add<u64> for PhysFrame<S>

where S: PageSize,

type Output = PhysFrame<S>

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <PhysFrame<S> as Add<u64>>::Output

Performs the + operation.

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

where S: PageSize,

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl<S> Clone for PhysFrame<S>

where S: Clone + PageSize,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Copy for PhysFrame<S>

where S: Copy + PageSize,

impl<S> Debug for PhysFrame<S>

where S: PageSize,

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

Formats the value using the given formatter.

impl<S> Eq for PhysFrame<S>

where S: Eq + PageSize,

impl<S> Hash for PhysFrame<S>

where S: Hash + PageSize,

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

where __H: Hasher,

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<S> Ord for PhysFrame<S>

where S: Ord + PageSize,

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

Restrict a value to a certain interval.

impl<S> PartialEq for PhysFrame<S>

where S: PartialEq + PageSize,

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

Equality operator ==.

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

Inequality operator !=.

impl<S> PartialOrd for PhysFrame<S>

where S: PartialOrd + PageSize,

fn partial_cmp(&self, other: &PhysFrame<S>) -> 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<S> StructuralPartialEq for PhysFrame<S>

where S: PartialEq + PageSize,

impl<S> Sub for PhysFrame<S>

where S: PageSize,

type Output = u64

The resulting type after applying the - operator.

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

Performs the - operation.

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

where S: PageSize,

type Output = PhysFrame<S>

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <PhysFrame<S> as Sub<u64>>::Output

Performs the - operation.

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

where S: PageSize,

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.