Struct Box

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

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: AsRef<[u8]>,

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

👎Deprecated since 0.7.3: This can access uninitialized memory, use init(..) instead (https://github.com/japaric/heapless/issues/212)

(DO NOT USE, SEE DEPRECATION) 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> AsMut<[T]> for Box<P>

where P: Pool, P::Data: AsMut<[T]>,

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

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

impl<P, T> AsRef<[T]> for Box<P>

where P: Pool, P::Data: AsRef<[T]>,

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

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

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 as Pool>::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> 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.

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

where H: Hasher, Self: Sized,

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<P> PartialEq for Box<P>

where P: Pool, P::Data: PartialEq,

fn eq(&self, rhs: &Box<P>) -> 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<P> PartialOrd 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.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<P> Eq for Box<P>

where P: Pool, P::Data: Eq,

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,