Struct heapless::pool::singleton::Box

pub struct Box<POOL, STATE = Init> where
    POOL: Pool,
    STATE: 'static,  { /* fields omitted */ }

A memory block that belongs to the global memory pool, POOL

Implementations

impl<P> Box<P, Uninit> where
    P: Pool, 

pub fn init(self, val: P::Data) -> Box<P, Init>

Initializes this memory block

impl<P> Box<P, Uninit> where
    P: Pool,
    P::Data: AsSlice<Element = u8>, 

pub fn freeze(self) -> Box<P, Init>

Freezes the contents of this memory block

See rust-lang/rust#58363 for details.

impl<P> Box<P, Init> where
    P: Pool, 

pub fn forget(self) -> Box<P, Uninit>

Forgets the contents of this memory block without running its destructor.

Note that this this does not return the memory block to the pool. The block can be reused, or returned to the pool by dropping it.

Trait Implementations

impl<P, T> AsMutSlice for Box<P> where
    P: Pool,
    P::Data: AsMutSlice<Element = T>, 

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

Returns the mutable slice view of Self

impl<P, T> AsSlice for Box<P> where
    P: Pool,
    P::Data: AsSlice<Element = T>, 

type Element = T

The element type of the slice view

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

Returns the immutable slice view of Self

impl<P> Debug for Box<P> where
    P: Pool,
    P::Data: Debug, 

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

Formats the value using the given formatter.

impl<P> Deref for Box<P> where
    P: Pool, 

type Target = P::Data

The resulting type after dereferencing.

fn deref(&self) -> &P::Data

Dereferences the value.

impl<P> DerefMut for Box<P> where
    P: Pool, 

fn deref_mut(&mut self) -> &mut P::Data

Mutably dereferences the value.

impl<P> Display for Box<P> where
    P: Pool,
    P::Data: Display, 

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

Formats the value using the given formatter.

impl<P, S> Drop for Box<P, S> where
    P: Pool,
    S: 'static, 

fn drop(&mut self)

Executes the destructor for this type.

impl<P> Eq for Box<P> where
    P: Pool,
    P::Data: Eq, 

impl<P> Hash for Box<P> where
    P: Pool,
    P::Data: Hash, 

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<P> Ord for Box<P> where
    P: Pool,
    P::Data: Ord, 

fn cmp(&self, rhs: &Box<P>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<P> PartialEq<Box<P, Init>> for Box<P> where
    P: Pool,
    P::Data: PartialEq, 

fn eq(&self, rhs: &Box<P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<P> PartialOrd<Box<P, Init>> for Box<P> where
    P: Pool,
    P::Data: PartialOrd, 

fn partial_cmp(&self, rhs: &Box<P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<P, S> Send for Box<P, S> where
    P: Pool,
    P::Data: Send, 

impl<P: Pool> StableDeref for Box<P>

impl<P, S> Sync for Box<P, S> where
    P: Pool,
    P::Data: Sync,