Struct syscall_encode::ptr::UserPointer

pub struct UserPointer<'abi, T> { /* private fields */ }

A type representing a user pointer.

Implementations

impl<'abi, T> UserPointer<'abi, T>

pub fn new(ptr: &'abi T) -> UserPointer<'abi, T>

Construct a new user pointer.

pub fn new_null() -> UserPointer<'abi, T>

Construct a new null user pointer.

pub fn is_null(&self) -> bool

Is this a null user pointer?

impl<'abi, T> UserPointer<'abi, T>where T: Sync,

pub fn as_ref(&self, f: impl FnOnce(*const T, usize) -> bool) -> Option<&'abi T>

Verify a user pointer, and return it as a reference. Should be called by the kernel before using the pointer. The supplied closure should implement the kernel’s security and address space verification for this pointer. The closure should return true if the contiguous memory region delimited by the arguments is okay for the kernel to read. Note that this means the following:

1. The userspace code has perms to read the memory.
2. The kernel has perms to read the memory.
3. The region is in a valid part of the address space.
4. T is Sync.

pub fn as_mut( &mut self, f: impl FnOnce(*mut T, usize) -> bool ) -> Option<&'abi mut T>

See Self::as_ref.

Trait Implementations

impl<'abi, T> Clone for UserPointer<'abi, T>where T: Clone,

fn clone(&self) -> UserPointer<'abi, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'abi, T> Debug for UserPointer<'abi, T>where T: Debug,

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

Formats the value using the given formatter.

impl<'abi, T> From<&'abi T> for UserPointer<'abi, T>

fn from(value: &'abi T) -> UserPointer<'abi, T>

Converts to this type from the input type.

impl<'abi, T> From<&'abi mut T> for UserPointer<'abi, T>

fn from(value: &'abi mut T) -> UserPointer<'abi, T>

Converts to this type from the input type.

impl<'abi, T> Hash for UserPointer<'abi, T>where T: Hash,

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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<'abi, T> Ord for UserPointer<'abi, T>where T: Ord,

fn cmp(&self, other: &UserPointer<'abi, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'abi, T> PartialEq<UserPointer<'abi, T>> for UserPointer<'abi, T>where T: PartialEq<T>,

fn eq(&self, other: &UserPointer<'abi, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'abi, T> PartialOrd<UserPointer<'abi, T>> for UserPointer<'abi, T>where T: PartialOrd<T>,

fn partial_cmp(&self, other: &UserPointer<'abi, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, Abi, EncodedType, Encoder, T> SyscallEncodable<'a, Abi, EncodedType, Encoder> for UserPointer<'a, T>where Abi: SyscallAbi, EncodedType: Copy, Encoder: SyscallEncoder<'a, Abi, EncodedType>, T: Copy,

fn encode(&self, encoder: &mut Encoder) -> Result<(), EncodeError>

fn decode(decoder: &mut Encoder) -> Result<UserPointer<'a, T>, DecodeError>where UserPointer<'a, T>: Sized,

impl<'abi, T> Copy for UserPointer<'abi, T>where T: Copy,

impl<'abi, T> Eq for UserPointer<'abi, T>where T: Eq,

impl<'abi, T> StructuralEq for UserPointer<'abi, T>

impl<'abi, T> StructuralPartialEq for UserPointer<'abi, T>