Struct boxed::Box

#[lang = "owned_box"]
pub struct Box<T: ?Sized, A: Alloc> { /* fields omitted */ }

Pointer to heap-allocated value

Methods

impl<T, A: Alloc> Box<T, A>

fn new_in(a: A, x: T) -> Result<Self, T>

impl<T, A: Alloc + Default> Box<T, A>

fn new(x: T) -> Result<Self, T>

Allocate memory on the heap and then move x into it.

impl<T: ?Sized, A: Alloc> Box<T, A>

unsafe fn from_raw_in(a: A, ptr: *mut T) -> Self

Make a Box of a raw pointer. After calling this, the Box it returns owns the raw pointer. This means the Box destructor will drop the T and free the memory. As allocation technique of Box is unspecified, the only valid argument to this is Box::into_raw(_).

unsafe fn into_raw(self) -> *mut T

Consume a Box and return its raw pointer. The caller owns the memory the Box owned. This means the caller must make sure the T is dropped and the memory is deallocated. The proper way to do so is to call Box::from_raw to make a new Box of the pointer.

impl<T: ?Sized, A: Alloc + Default> Box<T, A>

unsafe fn from_raw(ptr: *mut T) -> Self

Make a Box of a raw pointer. After calling this, the Box it returns owns the raw pointer. This means the Box destructor will drop the T and free the memory. As allocation technique of Box is unspecified, the only valid argument to this is Box::into_raw(_).

Trait Implementations

impl<T: ?Sized, A: Alloc> Deref for Box<T, A>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized, A: Alloc> DerefMut for Box<T, A>

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

Mutably dereferences the value.

impl<T: ?Sized, A: Alloc> Drop for Box<T, A>

fn drop(&mut self)

Executes the destructor for this type.