Struct OversizedBox

pub struct OversizedBox<T: ?Sized, S> { /* private fields */ }

A Box for T with an allocation whose size and alignment is the same as S.

Implementations

impl<T, S> OversizedBox<T, S>

pub fn new(t: T) -> Self

Allocates a new box and inserts t.

OversizedBox::<_, u64>::new(0u32);

Fails to compile if T’s size or alignment is larger than S’s.

OversizedBox::<_, u32>::new(0u64);

pub fn pin(t: T) -> Pin<Self>

Allocates a new box, inserts t, and pins the box.

impl<T: ?Sized, S> OversizedBox<T, S>

pub fn refill<T2>(this: Self, t: T2) -> OversizedBox<T2, S>

Drops the current contents of the box, then replaces them with t.

Returns the new box, which may have a different type from the current one.

Panics if T2’s size or alignment is larger than S’s.

pub fn empty(this: Self) -> OversizedBox<(), S>

Empties the box, dropping the contents but preserving the allocation.

pub fn empty_pinned(this: Pin<Self>) -> OversizedBox<(), S>

Empties a pinned box, dropping the contents but preserving the allocation.

pub fn into_pin(this: Self) -> Pin<Self>

Pins the box.

pub fn into_raw(this: Self) -> (NonNull<T>, PhantomData<*mut S>)

Consumes this and returns the allocation plus the phantom data specifying the allocation type.

The phantom data is returned to make coerce! work.

pub unsafe fn from_raw(t: NonNull<T>, s: PhantomData<*mut S>) -> Self

Re-creates the box from the allocation plus phantom data specifying the underlying allocation type.

The phantom data is consumed to make coerce! work.

Safety

t must have been returned from into_raw.

Trait Implementations

impl<T: ?Sized, S> AsMut<T> for OversizedBox<T, S>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized, S> AsRef<T> for OversizedBox<T, S>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized, S> Deref for OversizedBox<T, S>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized, S> DerefMut for OversizedBox<T, S>

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

Mutably dereferences the value.

impl<T: ?Sized, S> Drop for OversizedBox<T, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized, S> From<OversizedBox<T, S>> for Pin<OversizedBox<T, S>>

fn from(this: OversizedBox<T, S>) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Send, S> Send for OversizedBox<T, S>

impl<T: ?Sized + Sync, S> Sync for OversizedBox<T, S>

impl<T: ?Sized, S> Unpin for OversizedBox<T, S>