Struct heapless::pool::singleton::Box

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

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

Implementations§

source§

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

source

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

Initializes this memory block

source§

impl<P> Box<P, Uninit>
where P: Pool, P::Data: AsRef<[u8]>,

source

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.

source§

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

source

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§

source§

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

source§

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

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

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

source§

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

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

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Target = <P as Pool>::Data

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

source§

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<POOL, STATE> Freeze for Box<POOL, STATE>

§

impl<POOL, STATE = Init> !RefUnwindSafe for Box<POOL, STATE>

§

impl<POOL, STATE> Unpin for Box<POOL, STATE>
where POOL: Unpin, STATE: Unpin,

§

impl<POOL, STATE = Init> !UnwindSafe for Box<POOL, STATE>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.