Struct Box

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

A heap-allocated memory block.

Implementations

impl<T> Box<[T]>

pub fn new_slice_zeroed(len: usize) -> Result<Self, KernelError>

Create a new zeroed heap-allocated slice with the given length.

len - The length of the slice.

Returns a new heap-allocated slice with the given length or an error if the allocation failed.

pub const fn new_slice_empty() -> Self

Create a new empty slice.

Returns a new empty slice.

pub fn new_slice_uninit( len: usize, ) -> Result<Box<[MaybeUninit<T>]>, KernelError>

Create a new uninit heap-allocated slice with the given length.

len - The length of the slice.

Returns a new heap-allocated slice with the given length or an error if the allocation failed.

impl<T> Box<T>

pub fn new(value: T) -> Option<Self>

Create a new heap-allocated value.

value - The value to store on the heap.

Returns a new heap-allocated value or None if the allocation failed.

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

Returns a mutable reference to the heap-allocated value.

pub fn as_ref(&self) -> &T

Returns an immutable reference to the heap-allocated value.

pub fn into_raw(self) -> NonNull<T>

Consumes the Box, returning a pointer to the heap-allocated value.

The caller is responsible for freeing the memory with the global free function. A pointer created with this function can be converted back into a Box with the from_raw function.

pub unsafe fn from_raw(ptr: NonNull<T>) -> Self

Moves a pointer to a heap-allocated value into a Box.

ptr - The pointer to the heap-allocated value.

Returns a new Box managing the given pointer.

Safety

The caller must ensure that the pointer is valid and that the memory is not freed while the Box is alive.

The caller must ensure that the following conditions are met:

• The pointer must be allocated with the global malloc function.
• The pointer must be unique and not aliased.
• The pointer must be properly aligned.
• The pointer must point to a valid T.

The Box takes ownership of the memory and will free it with the global allocator when dropped.

Trait Implementations

impl<T> AsMut<T> for Box<T>

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

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

impl<T> AsRef<T> for Box<T>

fn as_ref(&self) -> &T

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

impl<T> Deref for Box<[T]>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<T> Deref for Box<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Box<[T]>

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

Mutably dereferences the value.

impl<T> DerefMut for Box<T>

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

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Index<Range<usize>> for Box<[T]>

type Output = [T]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFrom<usize>> for Box<[T]>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<RangeTo<usize>> for Box<[T]>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for Box<[T]>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Range<usize>> for Box<[T]>

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeFrom<usize>> for Box<[T]>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeTo<usize>> for Box<[T]>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<usize> for Box<[T]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.