Struct kernel::pages::Pages

source · [−]

pub struct Pages<const ORDER: u32> { /* private fields */ }

Expand description

A set of physical pages.

Pages holds a reference to a set of pages of order ORDER. Having the order as a generic const allows the struct to have the same size as a pointer.

Invariants

The pointer Pages::pages is valid and points to 2^ORDER pages.

Implementations

source

impl<const ORDER: u32> Pages<ORDER>

source

pub fn new() -> Result<Self>

Allocates a new set of contiguous pages.

source

pub fn copy_into_page(
    &self,
    reader: &mut UserSlicePtrReader,
    offset: usize,
    len: usize
) -> Result

Copies data from the given UserSlicePtrReader into the pages.

source

pub unsafe fn read(&self, dest: *mut u8, offset: usize, len: usize) -> Result

Maps the pages and reads from them into the given buffer.

Callers must ensure that the destination buffer is valid for the given length. Additionally, if the raw buffer is intended to be recast, they must ensure that the data can be safely cast; crate::io_buffer::ReadableFromBytes has more details about it.

source

pub unsafe fn write(&self, src: *const u8, offset: usize, len: usize) -> Result

Maps the pages and writes into them from the given buffer.

Safety

Callers must ensure that the buffer is valid for the given length. Additionally, if the page is (or will be) mapped by userspace, they must ensure that no kernel data is leaked through padding if it was cast from another type; crate::io_buffer::WritableToBytes has more details about it.

Trait Implementations

source

impl<const ORDER: u32> Drop for Pages<ORDER>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations

impl<const ORDER: u32> RefUnwindSafe for Pages<ORDER>

impl<const ORDER: u32> !Send for Pages<ORDER>

impl<const ORDER: u32> !Sync for Pages<ORDER>

impl<const ORDER: u32> Unpin for Pages<ORDER>

impl<const ORDER: u32> UnwindSafe for Pages<ORDER>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct kernel::pages::Pages

Invariants

Implementations

impl<const ORDER: u32> Pages<ORDER>

pub fn new() -> Result<Self>

pub fn copy_into_page(
    &self,
    reader: &mut UserSlicePtrReader,
    offset: usize,
    len: usize
) -> Result

pub unsafe fn read(&self, dest: *mut u8, offset: usize, len: usize) -> Result

Safety

pub unsafe fn write(&self, src: *const u8, offset: usize, len: usize) -> Result

Safety

Trait Implementations

impl<const ORDER: u32> Drop for Pages<ORDER>

fn drop(&mut self)

Auto Trait Implementations

impl<const ORDER: u32> RefUnwindSafe for Pages<ORDER>

impl<const ORDER: u32> !Send for Pages<ORDER>

impl<const ORDER: u32> !Sync for Pages<ORDER>

impl<const ORDER: u32> Unpin for Pages<ORDER>

impl<const ORDER: u32> UnwindSafe for Pages<ORDER>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct kernel::pages::Pages

Implementations

impl<const ORDER: u32> Pages<ORDER>

pub fn new() -> Result<Self>

pub fn copy_into_page( &self, reader: &mut UserSlicePtrReader, offset: usize, len: usize) -> Result

pub unsafe fn read(&self, dest: *mut u8, offset: usize, len: usize) -> Result

pub unsafe fn write(&self, src: *const u8, offset: usize, len: usize) -> Result

Trait Implementations

impl<const ORDER: u32> Drop for Pages<ORDER>

fn drop(&mut self)

Auto Trait Implementations

impl<const ORDER: u32> RefUnwindSafe for Pages<ORDER>

impl<const ORDER: u32> !Send for Pages<ORDER>

impl<const ORDER: u32> !Sync for Pages<ORDER>

impl<const ORDER: u32> Unpin for Pages<ORDER>

impl<const ORDER: u32> UnwindSafe for Pages<ORDER>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn copy_into_page(
&self,
reader: &mut UserSlicePtrReader,
offset: usize,
len: usize
) -> Result

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,