Struct Pages

pub struct Pages { /* private fields */ }

Represents a page, or range of pages with Immutable accessibility

Implementations

impl Pages

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

Converts this MutPages into Pages, updating the protection of the underlying pages

Errors

Will error if protecting the pages fails, error object contains self.

impl Pages

pub fn split(self, index: usize) -> Result<(Self, Self), Self>

Splits this Pages into two consecutive Pages at a given index

Errors

If the index would result in one half of the split having 0 size, this will return itself back out as an error

pub fn set_locked(&mut self, locked: bool) -> Result<()>

Sets whether the pages represented by this Pages is locked into memory or not. See mlock(2)

Errors

If the OS returns an error from the mlock or munlock syscall, it is returned as an io::Error

pub fn join<const C: usize>( parts: [PagesType; C], ) -> Result<Self, JoinError<[PagesType; C]>>

Joins two or more contiguous pages from the same allocation into a single object, updating the protection of the memory region in a single syscall if nessassary.

Errors

See JoinErrorKind docs. Will return a JoinError containing the input PagesTypes and a JoinErrorKind containing what went wrong.

pub fn join_vec( parts: Vec<PagesType>, ) -> Result<Self, JoinError<Vec<PagesType>>>

Joins two or more contiguous pages from the same allocation into a single object, updating the protection of the memory region in a single syscall if nessassary. Accepts a Vec as an input rather than a const size array like Self::join

Errors

See JoinErrorKind docs. Will return a JoinError containing the input PagesTypes and a JoinErrorKind containing what went wrong.

pub fn try_into_allocation(self) -> Result<Allocation, Self>

Converts this Pages into an Allocation. If the only reference that still exists to pages inside the allocation is through self, then this will succeed. Other references can be removed by dropping other pages objects or by joining them together through Self::join or Self::join_vec.

Errors

Will return Self as an error if other references to the allocation still exist.

impl Pages

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

Converts this InaccessiblePages into Pages, updating the protection of the underlying pages

Errors

Will error if protecting the pages fails, error object contains self.

Trait Implementations

impl AnyPages for Pages

fn start(&self) -> usize

Gets the start index of the page of the underlying allocation which this object references

fn end(&self) -> usize

Gets the end index of the page of the underlying allocation which this object references

fn accessibility(&self) -> Accessibility

Gets the Accessibility of this pages object

fn allocation(&self) -> &Allocation

Gets an immutable reference to the underlying Allocation

fn as_any(&self) -> &dyn Any

Gets this pages object as a &dyn Any object for reference downcasting

fn as_any_mut(&mut self) -> &mut dyn Any

Gets this pages object as a &mut dyn Any object for reference downcasting

fn into_pages_type(self) -> PagesType

Gets this pages object as a PagesType enum to allow pattern matching and unwrapping on accessibility

fn as_ptr(&self) -> *const u8

Returns a raw pointer to the page(s)

fn pages(&self) -> usize

Gets the number of pages this pages object references

fn len_bytes(&self) -> usize

Gets the number of bytes this pages object references. This is implemented as AnyPages::pages multiplied by the page size

impl Debug for Pages

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

Formats the value using the given formatter.

impl From<Pages> for PagesType

fn from(value: Pages) -> PagesType

Converts to this type from the input type.

impl SlicePages for Pages

fn slice(&self) -> &[u8]

Gets a slice of the raw bytes of the pages represented by this pages object

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 Pages

type Error = IntoPagesError<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 Pages

type Error = IntoPagesError<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 TryFrom<Pages> for InaccessiblePages

type Error = IntoPagesError<Pages>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Pages> for MutPages

type Error = IntoPagesError<Pages>

The type returned in the event of a conversion error.

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

Performs the conversion.