Struct outref::Out

#[repr(transparent)]
pub struct Out<'a, T: 'a + ?Sized> { /* private fields */ }

Out reference (&'a out T).

An out reference is similar to a mutable reference, but it may point to uninitialized memory. An out reference may be used to initialize the pointee or represent a data buffer.

&'a out T can be converted from:

• &'a mut MaybeUninit<T> and &'a mut [MaybeUninit<T>], where the T may be uninitialized.
• &'a mut T and &'a mut [T], where the T is initialized and Copy.

It is not allowed to corrupt or de-initialize the pointee, which may cause unsoundness. It is the main difference between &'a out T and &'a mut MaybeUninit<T> /&'a mut [MaybeUninit<T>].

Any reads through an out reference may read uninitialized value(s).

Implementations

impl<'a, T: ?Sized> Out<'a, T>

pub unsafe fn new(data: *mut T) -> Self

Forms an Out<'a, T>

Safety

• data must be valid for writes.
• data must be properly aligned.

pub unsafe fn assume_init(self) -> &'a mut T

Converts to a mutable (unique) reference to the value.

Safety

The referenced value must be initialized when calling this function.

pub fn reborrow<'s>(&'s mut self) -> Out<'s, T>where
    'a: 's,

Reborrows the out reference for a shorter lifetime.

impl<'a, T> Out<'a, T>

pub fn from_mut(data: &'a mut T) -> Selfwhere
    T: Copy,

Forms an Out<'a, T>.

pub fn from_uninit(data: &'a mut MaybeUninit<T>) -> Self

Forms an Out<'a, T> from an uninitialized value.

pub unsafe fn into_uninit(self) -> &'a mut MaybeUninit<T>

Converts to &'a mut MaybeUninit<T>

Safety

It is not allowed to corrupt or de-initialize the pointee.

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

Returns an unsafe mutable pointer to the value.

impl<'a, T> Out<'a, [T]>

pub fn from_slice(slice: &'a mut [T]) -> Selfwhere
    T: Copy,

Forms an Out<'a, [T]>.

pub fn from_uninit_slice(slice: &'a mut [MaybeUninit<T>]) -> Self

Forms an Out<'a, [T]> from an uninitialized slice.

pub unsafe fn into_uninit_slice(self) -> &'a mut [MaybeUninit<T>]

Converts to &'a mut [MaybeUninit<T>]

Safety

It is not allowed to corrupt or de-initialize the pointee.

pub const fn is_empty(&self) -> bool

Returns true if the slice has a length of 0.

pub const fn len(&self) -> usize

Returns the number of elements in the slice.

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

Returns an unsafe mutable pointer to the slice’s buffer.

Trait Implementations

impl<T: Send> Send for Out<'_, T>

impl<T: Sync> Sync for Out<'_, T>

impl<T: Unpin> Unpin for Out<'_, T>