Struct PageLayout

pub struct PageLayout(/* private fields */);

Layout of a range of pages.

This is analogous to Layout, but requires the size and alignment to refer to whole pages.

Implementations

impl PageLayout

pub const fn from_size_align( size: usize, align: usize, ) -> Result<Self, PageLayoutError>

Constructs a PageLayout from a given size and align, or returns PageLayoutError if any of the following conditions are not met:

• align must not be zero,

• align must be a power of two,

• size, when rounded up to the nearest multiple of align, must not overflow isize (i.e., the rounded value must be less than or equal to isize::MAX),

• size and align must both be aligned to PAGE_SIZE.

pub const unsafe fn from_size_align_unchecked(size: usize, align: usize) -> Self

Creates a page layout, bypassing all checks.

Safety

This function is unsafe as it does not verify the preconditions from PageLayout::from_size_align.

pub const fn from_size(size: usize) -> Result<Self, PageLayoutError>

Creates a page layout with PAGE_SIZE alignment.

pub const fn size(&self) -> usize

The minimum size in bytes for a memory block of this page layout.

pub const fn align(&self) -> usize

The minimum byte

Trait Implementations

impl Clone for PageLayout

fn clone(&self) -> PageLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageLayout

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

Formats the value using the given formatter.

impl From<PageLayout> for Layout

fn from(value: PageLayout) -> Self

Converts to this type from the input type.

impl Hash for PageLayout

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 PartialEq for PageLayout

fn eq(&self, other: &PageLayout) -> 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 TryFrom<Layout> for PageLayout

type Error = PageLayoutError

The type returned in the event of a conversion error.

fn try_from(value: Layout) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PageLayout

impl Eq for PageLayout

impl StructuralPartialEq for PageLayout