Struct out_reference::Out

#[repr(transparent)]pub struct Out<'a, T: ?Sized>(_, _);

An Out Reference, you can only write to this reference using the set method and reborrow this reference with the borrow method. It isn't safe to read from an Out pointer.

Implementations

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

pub fn from_maybe_uninit(maybe_uninit: &mut MaybeUninit<T>) -> Out<'_, T>

To allow writing to the value inside the MaybeUninit

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

pub fn from_mut(value: &'a mut T) -> Self

Create Out from exclusive reference

pub unsafe fn from_raw(ptr: *mut T) -> Out<'a, T>

Create Out from raw pointer

pub fn borrow(&mut self) -> Out<'_, T>

Reborrows the Out reference

pub fn into_raw(self) -> *mut T

Convert this Out reference into a raw pointer

see as_mut_ptr for safety documentation of the this pointer.

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

Get a raw pointer to the Out, it is only safe to write to this pointer unless specified otherwise by the creator of this Out reference

i.e. it's safe to read to an Out<'_, T> that was created from a &mut T and it's safe to read from a Out<'_, T> that was created from a &mut MaybeUninit<T> after it has been initialized.

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

pub fn set(&mut self, value: T)

Set the value behind the Out reference *without dropping the old value *

Trait Implementations

impl<'a, T: Debug + ?Sized> Debug for Out<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> From<&'a mut MaybeUninit<T>> for Out<'a, T>

pub fn from(ptr: &'a mut MaybeUninit<T>) -> Self

Performs the conversion.

impl<'a, T: ?Sized> From<&'a mut T> for Out<'a, T>

pub fn from(ptr: &'a mut T) -> Self

Performs the conversion.