Struct std::os::fortanix_sgx::usercalls::alloc::User

pub struct User<T: UserSafe + ?Sized>(_);

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

An owned type in userspace memory. User<T> is equivalent to Box<T> in enclave memory. Access to the memory is only allowed by copying to avoid TOCTTOU issues. The user memory will be freed when the value is dropped. After copying, code should make sure to completely check the value before use.

Implementations

impl<T: ?Sized> User<T> where
    T: UserSafe, 

pub fn new_from_enclave(val: &T) -> Self

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies val into freshly allocated space in user memory.

pub unsafe fn from_raw(ptr: *mut T) -> Self

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Creates an owned User<T> from a raw pointer.

Safety

The caller must ensure ptr points to T, is freeable with the free usercall and the alignment of T, and is uniquely owned.

Panics

This function panics if:

• The pointer is not aligned
• The pointer is null
• The pointed-to range is not in user memory

pub fn into_raw(self) -> *mut T

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Converts this value into a raw pointer. The value will no longer be automatically freed.

impl<T> User<T> where
    T: UserSafe, 

pub fn uninitialized() -> Self

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Allocate space for T in user memory.

impl<T> User<[T]> where
    [T]: UserSafe, 

pub fn uninitialized(n: usize) -> Self

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Allocate space for a [T] of n elements in user memory.

pub unsafe fn from_raw_parts(ptr: *mut T, len: usize) -> Self

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Creates an owned User<[T]> from a raw thin pointer and a slice length.

Safety

The caller must ensure ptr points to len elements of T, is freeable with the free usercall and the alignment of T, and is uniquely owned.

Panics

This function panics if:

• The pointer is not aligned
• The pointer is null
• The pointed-to range does not fit in the address space
• The pointed-to range is not in user memory

Methods from Deref<Target = UserRef<T>>

pub fn copy_from_enclave(&mut self, val: &T)

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies val into user memory.

Panics

This function panics if the destination doesn't have the same size as the source. This can happen for dynamically-sized types such as slices.

pub fn copy_to_enclave(&self, dest: &mut T)

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies the value from user memory and place it into dest.

Panics

This function panics if the destination doesn't have the same size as the source. This can happen for dynamically-sized types such as slices.

pub fn as_raw_ptr(&self) -> *const T

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Obtain a raw pointer from this reference.

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

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Obtain a raw pointer from this reference.

pub fn to_enclave(&self) -> T

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies the value from user memory into enclave memory.

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

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Obtain a raw pointer to the first element of this user slice.

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

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Obtain a raw pointer to the first element of this user slice.

pub fn len(&self) -> usize

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Obtain the number of elements in this user slice.

pub fn copy_to_enclave_vec(&self, dest: &mut Vec<T>)

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies the value from user memory and place it into dest. Afterwards, dest will contain exactly self.len() elements.

Panics

This function panics if the destination doesn't have the same size as the source. This can happen for dynamically-sized types such as slices.

pub fn to_enclave(&self) -> Vec<T>

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies the value from user memory into a vector in enclave memory.

pub fn iter(&self) -> Iter<T> where
    T: UserSafe, 

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Returns an iterator over the slice.

pub fn iter_mut(&mut self) -> IterMut<T> where
    T: UserSafe, 

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Returns an iterator that allows modifying each value.

pub fn copy_user_buffer(&self) -> Vec<u8>

🔬 This is a nightly-only experimental API. (sgx_platform #56975)

Copies the user memory range pointed to by the user ByteBuffer to enclave memory.

Panics

This function panics if, in the user ByteBuffer:

• The pointer is null
• The pointed-to range does not fit in the address space
• The pointed-to range is not in user memory

Trait Implementations

impl<T: ?Sized> Deref for User<T> where
    T: UserSafe, 

type Target = UserRef<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized> DerefMut for User<T> where
    T: UserSafe, 

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ?Sized> Drop for User<T> where
    T: UserSafe, 

fn drop(&mut self)

Executes the destructor for this type.