Struct heapless::pool::singleton::arc::Arc

pub struct Arc<P>
where
    P: Pool,
{ /* private fields */ }

std::sync::Arc but backed by a memory Pool rather than #[global_allocator]

An example and more details can be found in the module level documentation.

Implementations

impl<P> Arc<P>

where P: Pool,

pub fn new(data: P::Data) -> Result<Self, P::Data>

Constructs a new Arc

Returns an Error if the backing memory pool is empty

Trait Implementations

impl<P> AsRef<<P as Pool>::Data> for Arc<P>

where P: Pool,

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

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

impl<P> Clone for Arc<P>

where P: Pool,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P> Debug for Arc<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 Arc<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> Display for Arc<P>

where P: Pool, P::Data: Display,

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

Formats the value using the given formatter.

impl<P> Drop for Arc<P>

where P: Pool,

fn drop(&mut self)

Executes the destructor for this type.

impl<P> Hash for Arc<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 Arc<P>

where P: Pool, P::Data: Ord,

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<P> PartialEq for Arc<P>

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

fn eq(&self, other: &Self) -> bool

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

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

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

impl<P> PartialOrd for Arc<P>

where P: Pool, P::Data: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

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> Eq for Arc<P>

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

impl<P> Send for Arc<P>

where P: Pool, P::Data: Sync + Send,

impl<P> Sync for Arc<P>

where P: Pool, P::Data: Sync + Send,

impl<P> Unpin for Arc<P>

where P: Pool,