Struct SharedCell

pub struct SharedCell<T> { /* private fields */ }

A wrapper class that facilitates sharing an item across different users, supporting:

• Ability grab a reference-counted reference to the item
• Ability to consume the item, leaving the cell in an unusable state

Implementations

impl<T> SharedCell<T>

pub fn borrow(&self) -> Result<SharedCellRef<T>, EmptyCellError>

Borrow the cell, returning a reference to the item. If the cell is empty, returns an error. While references are held, the cell cannot be taken below.

pub async fn with_mut<F, R>(&self, f: F) -> Result<R, EmptyCellError>

where F: FnOnce(&mut T) -> R,

Execute given closure with write access to the underlying data. If the cell is empty, returns an error.

pub async fn take(&self) -> Result<T, EmptyCellError>

Take the item out of the cell, leaving it in an unusable state.

pub fn blocking_take(&self) -> Result<T, EmptyCellError>

pub fn try_take(&self) -> Result<T, TryTakeError>

Trait Implementations

impl<T> Clone for SharedCell<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SharedCell<T>

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

Formats the value using the given formatter.

impl<T> From<T> for SharedCell<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Send + Sync> SharedCellDiscard for SharedCell<T>

fn try_discard(&self) -> Result<(), TryTakeError>

fn discard<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), EmptyCellError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn blocking_discard(&self) -> Result<(), EmptyCellError>