Struct FuriBox 

pub struct FuriBox<T: ?Sized>(/* private fields */);

Heap-allocated value.

This is intended for situations where it is not possible to rely upon a global allocator. Most users should make use of flipperzero-alloc.

Implementations

impl<T> FuriBox<T>

pub fn new(value: T) -> Self

Allocates and initializes a correctly aligned value on the system heap.

pub fn into_raw(b: FuriBox<T>) -> *mut T

Consume the box and return raw pointer.

Caller is responsible for calling T::drop() and freeing the pointer with aligned_free.

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

Constructs a box from a raw pointer.

Safety

This function is unsafe because improper use may lead to memory problems.

The caller is responsible for ensuring the pointer is non-null, was allocated using aligned_malloc with the correct alignment for T and that the memory represents a valid T.

pub fn as_ptr(b: &FuriBox<T>) -> *const T

Returns a raw pointer to the Box’s contents.

The caller must ensure that the Box outlives the pointer this function returns, or else it will end up dangling.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the Box, use `as_mut_ptr``.

This method guarantees that for the purpose of the aliasing model, this method does not materialize a reference to the underlying memory, and thus the returned pointer will remain valid when mixed with other calls to as_ptr and as_mut_ptr.

pub fn as_mut_ptr(b: &mut FuriBox<T>) -> *mut T

Returns a raw mutable pointer to the Box’s contents.

The caller must ensure that the Box outlives the pointer this function returns, or else it will end up dangling.

This method guarantees that for the purpose of the aliasing model, this method does not materialize a reference to the underlying memory, and thus the returned pointer will remain valid when mixed with other calls to as_ptr`` and as_mut_ptr``.

Trait Implementations

impl<T: ?Sized> AsMut<T> for FuriBox<T>

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

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

impl<T: ?Sized> AsRef<T> for FuriBox<T>

fn as_ref(&self) -> &T

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

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T: PartialEq + ?Sized> PartialEq for FuriBox<T>

fn eq(&self, other: &FuriBox<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq + ?Sized> Eq for FuriBox<T>

impl<T: ?Sized> StructuralPartialEq for FuriBox<T>