Struct Box

pub struct Box<T: 'static + ?Sized> { /* private fields */ }

Owned pointer to a T.

Intended for similar use cases as the standard library Box, but this one does not free the memory on drop (though it does drop the T). Used sparingly in cases where we really need to own a dynamically allocated T instead of borrowing it, and using a static borrow would be too verbose.

Implementations

impl<T: ?Sized> Box<T>

pub fn from_mut(value: &'static mut T) -> Box<T>

Creates a Box from a leaked borrow of the boxed value.

pub unsafe fn from_ptr(ptr: *mut T) -> Box<T>

Creates a Box from a raw pointer to the boxed value.

Safety

The caller must ensure that the memory behind the pointer is never read, written, or freed while this Box exists, and that the T pointed to by this pointer is never accessed after this call, unless it’s after deconstructing this box with Box::into_ptr.

pub fn into_ptr(self) -> *mut T

Consumes the Box<T> without dropping the internal value and returns the internal pointer.

Trait Implementations

impl<T: ?Sized + Debug> Debug for Box<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Box<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> DerefMut for Box<T>

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

Mutably dereferences the value.

impl<T: ?Sized + Display> Display for Box<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for Box<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Sync> Sync for Box<T>