Struct UserInOutPtr 

pub struct UserInOutPtr<T> { /* private fields */ }

A wrapper around a mutable pointer to user memory (read-write).

Implementations

impl<T> UserInOutPtr<T>

pub const fn new(ptr: *mut T) -> Self

Constructs a new UserInOutPtr.

pub fn is_null(&self) -> bool

Returns true if the underlying pointer is null.

pub fn as_ptr(&self) -> *mut T

Returns the underlying raw pointer.

pub fn byte_offset(&self, count: isize) -> Self

Returns a pointer offset by count bytes.

pub fn element_offset(&self, index: usize) -> Self

Returns a pointer offset by index elements.

pub fn reinterpret<U>(&self) -> UserInOutPtr<U>

Reinterprets the pointer as a pointer to type U.

pub const fn as_in_ptr(&self) -> UserInPtr<T>

Returns a UserInPtr viewing the same user memory.

pub const fn as_out_ptr(&self) -> UserOutPtr<T>

Returns a UserOutPtr viewing the same user memory.

pub fn copy_from_user<'a>( &self, dst: &'a mut MaybeUninit<T>, ) -> Result<&'a mut T, Status>

where T: FromBytes + IntoBytes,

Copies a single element from userspace into dst.

pub fn read(&self) -> Result<T, Status>

where T: FromBytes + IntoBytes + Immutable,

Reads and returns a single copyable element from userspace.

pub fn copy_slice_from_user<'a>( &self, dst: &'a mut [MaybeUninit<T>], ) -> Result<&'a mut [T], Status>

where T: FromBytes + IntoBytes,

Copies a slice of elements from userspace into dst.

pub fn copy_to_user(&self, src: &T) -> Result<(), Status>

where T: IntoBytes + Immutable,

Copies a single element from src to userspace.

pub fn write(&self, val: T) -> Result<(), Status>

where T: IntoBytes + Immutable,

Writes a single copyable value to userspace.

pub fn copy_slice_to_user(&self, src: &[T]) -> Result<(), Status>

where T: IntoBytes + Immutable,

Copies a slice of elements from src to userspace.

Trait Implementations

impl<T: Clone> Clone for UserInOutPtr<T>

fn clone(&self) -> UserInOutPtr<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UserInOutPtr<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for UserInOutPtr<T>

fn default() -> UserInOutPtr<T>

Returns the “default value” for a type.

impl<T: Copy> Copy for UserInOutPtr<T>