Enum owned_alloc::MaybeUninitAlloc

pub enum MaybeUninitAlloc<T>where
    T: ?Sized,{
    Init(OwnedAlloc<T>),
    Uninit(UninitAlloc<T>),
}

Pointer to memory allocaation that might be either initialized or uninitialized. For the drop checker, the type acts as if it contains a T due to usage of PhantomData<T>.

Variants

Init(OwnedAlloc<T>)

Initialized allocation.

Uninit(UninitAlloc<T>)

Uninitialized allocation.

Implementations

impl<T> MaybeUninitAlloc<T>

pub fn or_init<F>(self, init: F) -> OwnedAlloc<T>where
    F: FnOnce() -> T,

If the allocation was initialized, this is a no-op. If it wasn’t, the passed function is called and its return value is used to initialize the memory. In both cases, an allocation considered initialized is returned.

impl<T> MaybeUninitAlloc<T>where
    T: ?Sized,

pub unsafe fn or_init_in_place<F>(self, init: F) -> OwnedAlloc<T>where
    F: FnOnce(&mut T),

If the allocation was initialized, this is a no-op. If it wasn’t, the passed function is called with a mutable reference to the uninitialized memory and the function is expected to initialize the memory. In both cases, an allocation considered initialized is returned.

Safety

This function is unsafe because the passed function might not initialize the memory correctly.

pub fn is_initialized(&self) -> bool

Tests if the allocation is initialized.

pub fn is_uninitialized(&self) -> bool

Tests if the allocation is uninitialized.

pub fn drop_in_place(self) -> UninitAlloc<T>

If the memory is initialized, this function drops its content. In any case, the allocation now with uninitialized content is returned.

pub fn init_as_ok(self) -> Result<OwnedAlloc<T>, UninitAlloc<T>>

Encodes this type as a Result with an OwnedAlloc as Ok.

pub fn uninit_as_ok(self) -> Result<UninitAlloc<T>, OwnedAlloc<T>>

Encodes this type as a Result with an UninitAlloc as Ok.

pub fn modify<F, A>(&mut self, visit: F) -> Option<A>where
    F: FnOnce(&mut T) -> A,

If the memory is uninitialized, None is returned. If it is initialized, the passed function is called with a mutable reference to the allocation, and its return value is wrapped into a Some.

Trait Implementations

impl<T> Debug for MaybeUninitAlloc<T>where
    T: ?Sized,

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

Formats the value using the given formatter.

impl<T> From<OwnedAlloc<T>> for MaybeUninitAlloc<T>where
    T: ?Sized,

fn from(alloc: OwnedAlloc<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for MaybeUninitAlloc<T>

fn from(val: T) -> Self

Converts to this type from the input type.

impl<T> From<UninitAlloc<T>> for MaybeUninitAlloc<T>where
    T: ?Sized,

fn from(alloc: UninitAlloc<T>) -> Self

Converts to this type from the input type.