Struct static_alloc::uninit::UninitView

#[must_use = "This is a pointer-like type that has no effect on its own."]
pub struct UninitView<'a, T: ?Sized>(_);

A non-mutable view on a region used in an Uninit.

Makes it possible to utilize the traversal methods (split*, cast*, ..) without requiring a mutable reference to the original Uninit. It will also never expose mutable pointers or accidentally offer an aliased mutable reference. Prefer this to instead avoiding the borrow of the Uninit and manually managing pointers to the region.

Methods

impl<'_> UninitView<'_, ()>

pub fn split_layout(&mut self, layout: Layout) -> Option<Self>

Split so that the second part fits the layout.

See Uninit::split_layout for more details.

impl<'a> UninitView<'a, ()>

pub fn split_cast<U>(&mut self) -> Option<UninitView<'a, U>>

Split so that the tail is aligned and valid for a U.

pub fn split_slice<U>(&mut self) -> Option<UninitView<'a, [U]>>

Split so that the tail is aligned for a slice [U].

impl<'_, T> UninitView<'_, T>

pub fn invent_for_zst() -> Self

Invent a new uninit allocation for a zero-sized type (ZST).

Panics

This method panics when the type parameter is not a zero sized type.

impl<'a, T> UninitView<'a, T>

pub fn split_at_byte(&mut self, at: usize) -> Option<UninitView<'a, ()>>

Split the uninit view at a byte boundary.

See Uninit::split_at_byte for more details.

pub fn from_maybe_uninit(mem: &'a MaybeUninit<T>) -> Self

Create an view to the inner bytes of a MaybeUninit.

This is hardly useful on its own but since UninitView mirrors the traversal methods of Uninit it can be used to get pointers to already initialized elements in an immutable context.

pub fn cast<U>(self) -> Result<UninitView<'a, U>, Self>

Try to cast to an UninitView for another type.

pub fn cast_slice<U>(self) -> Result<UninitView<'a, [U]>, Self>

Try to cast to an UninitView for a slice type.

pub fn split_to_fit(&mut self) -> UninitView<'a, ()>

Split off the tail that is not required for holding an instance of T.

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

pub fn empty() -> Self

Creates a pointer to an empty slice.

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

Get the pointer to the first element of the slice.

pub fn capacity(&self) -> usize

Calculate the theoretical capacity of a slice in the pointed-to allocation.

pub fn split_at(&mut self, at: usize) -> Option<Self>

Split the slice at an index.

pub fn split_first(&mut self) -> Option<UninitView<'a, T>>

Split the first element from the slice.

pub fn split_last(&mut self) -> Option<UninitView<'a, T>>

Split the last element from the slice.

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

pub fn borrow(&self) -> UninitView<T>

Borrow another view of the Uninit region.

pub const fn size(&self) -> usize

Get the byte size of the total allocation.

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

Acquires the underlying *const T pointer.

pub fn as_non_null(&self) -> NonNull<T>

Acquires the underlying pointer as a NonNull.

pub unsafe fn as_ref(&self) -> &T

Dereferences the content.

The resulting lifetime is bound to self so this behaves "as if" it were actually an instance of T that is getting borrowed. If a longer lifetime is needed, use into_ref.

Safety

The caller must ensure that the content has already been initialized.

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

Turn this into a reference to the content.

Safety

The caller must ensure that the content has already been initialized.

Trait Implementations

impl<'_, T: ?Sized> Debug for UninitView<'_, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, T> From<&'a MaybeUninit<T>> for UninitView<'a, T>

fn from(mem: &'a MaybeUninit<T>) -> Self

Performs the conversion.

impl<'_, T> Default for UninitView<'_, [T]>

fn default() -> Self

Returns the "default value" for a type.