Struct User

pub struct User<T>(T, NonNull<AddressSpaceInner>);

🔬This is a nightly-only experimental API. (kernel_ptr)

Tuple Fields

0: T

🔬This is a nightly-only experimental API. (kernel_ptr)

1: NonNull<AddressSpaceInner>

🔬This is a nightly-only experimental API. (kernel_ptr)

Implementations

impl<T: ?Sized> User<*const T>

pub fn new_in(from: *const T, address_space: &AddressSpace) -> Self

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn is_null(self) -> bool

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn cast<U>(self) -> User<*const U>

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn cast_mut(self) -> User<*mut T>

🔬This is a nightly-only experimental API. (kernel_ptr)

impl<T: ?Sized> User<*mut T>

pub fn new_in(from: *mut T, address_space: &AddressSpace) -> Self

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn is_null(self) -> bool

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn cast<U>(self) -> User<*mut U>

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn cast_const(self) -> User<*const T>

🔬This is a nightly-only experimental API. (kernel_ptr)

impl<T> User<*const T>

pub unsafe fn read(self) -> Result<T, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

pub unsafe fn read_unaligned(self) -> Result<T, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

pub unsafe fn copy_to_nonoverlapping( self, dest: *mut T, count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

dest must be valid to write to as defined by [core::ptr::write]

pub fn copy_to_user( self, dest: User<*mut T>, _count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

impl<T> User<*mut T>

pub unsafe fn read(self) -> Result<T, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

pub unsafe fn read_unaligned(self) -> Result<T, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

pub unsafe fn copy_to_nonoverlapping( self, dest: *mut T, count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of T

dest must be valid to write to as defined by [core::ptr::write]

pub fn copy_to_user( self, dest: User<*mut T>, _count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

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

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn write_unaligned(self, _val: T) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn copy_from_nonoverlapping( self, src: *const T, count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

src must be valid for a read of T as defined by [core::ptr::read]

pub fn copy_from_user( self, src: User<*const T>, count: usize, ) -> Result<(), PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

impl<T> User<*const [T]>

pub unsafe fn read_to_buffer(self) -> Result<Box<[T]>, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of [T]

pub fn is_empty(self) -> bool

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn len(self) -> usize

🔬This is a nightly-only experimental API. (kernel_ptr)

impl<T> User<*mut [T]>

pub unsafe fn read_to_buffer(self) -> Result<Box<[T]>, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)

Safety

The memory pointed to must be valid for a read of [T]

pub fn is_empty(self) -> bool

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn len(self) -> usize

🔬This is a nightly-only experimental API. (kernel_ptr)

pub fn write_from_buffer(self, val: &[T]) -> Result<usize, PointerError>

🔬This is a nightly-only experimental API. (kernel_ptr)