Struct Allocation

pub struct Allocation { /* private fields */ }

Represents an allocation of 1 or more pages of memory

Implementations

impl Allocation

pub fn try_new(pages: usize) -> Result<Self>

Creates a new allocation with a certain number of pages, returning an error on allocation failure

Panics

Panics when pages == 0

Errors

When allocation fails, instead of handling allocation error in the usual way by aborting, it will return an io::Error containing the OS error

pub fn new(pages: usize) -> Self

Crates a new allocation with a certain number of pages

Panics

Panics when pages == 0

pub fn free(self) -> Result<()>

Frees allocation memory

Errors

When freeing memory failed, instead of handling free error in the usual way by aborting, it will return an io::Error containing the OS error

pub const fn pages(&self) -> usize

Gets the number of pages this allocation represents

pub fn as_ptr(&self) -> *const u8

Returns a raw pointer to the allocation’s buffer

The caller must ensure the data is readable/writable before trying to access the data

impl Allocation

pub fn try_into_pages_mut(self) -> Result<MutPages, IntoPagesError<Self>>

Converts this Allocation into MutPages

Errors

Will error if protecting the pages fails, error object contains this Allocation.

impl Allocation

pub fn try_into_pages(self) -> Result<Pages, IntoPagesError<Self>>

Converts this Allocation into Pages

Errors

Will error if protecting the pages fails, error object contains this Allocation.

impl Allocation

pub fn try_into_pages_inaccessible( self, ) -> Result<InaccessiblePages, IntoPagesError<Self>>

Converts this Allocation into InaccessiblePages

Errors

Will error if protecting the pages fails, error object contains this Allocation.

Trait Implementations

impl Debug for Allocation

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

Formats the value using the given formatter.

impl Drop for Allocation

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<Allocation> for InaccessiblePages

type Error = IntoPagesError<Allocation>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Allocation> for MutPages

type Error = IntoPagesError<Allocation>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Allocation> for Pages

type Error = IntoPagesError<Allocation>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<InaccessiblePages> for Allocation

type Error = InaccessiblePages

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<MutPages> for Allocation

type Error = MutPages

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Pages> for Allocation

type Error = Pages

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for Allocation

impl Sync for Allocation