Struct LoopCell 

pub struct LoopCell<T>(/* private fields */);

Specialized cell for building iterators that handle a value (such as a shared buffer), make it available for processing, modification, etc., and then it needs to be available for the next iteration. Access is performed by LoopCell::access.

Because Cell is not Sync, the LoopCellAccess for LoopCells are not Send. This is particularly important when writing core::future::Futures and asynchronous code, which is often a place where you’d want this (e.g. handling streams of events). In that case, you want LoopSyncCell.

Unlike the internal cell data (which uses an Option), this cell type only implements Default if the type parameter implements Default, and contains the relevant default value.

If you access the LoopCell while something else is holding on to the LoopCell value, then you will not be able to obtain a value. You can also create an empty LoopCell that cannot provide any access

Implementations

impl<T> LoopCell<T>

pub const fn new(initial_value: T) -> Self

Create a new LoopCell with the given value

pub fn new_default() -> Self

where T: Default,

Create a new LoopCell using the default value of the type it holds

pub const fn new_empty() -> Self

Create a new, empty LoopCell that can never provide a value.

pub fn access(&self) -> Option<LoopCellAccess<'_, T>>

Attempt to access the loop cell, producing an accessor that will write back any changes to the cell once it is dropped (unless it’s manually disarmed).

Only produces Some if no other accessors are using this LoopCell

Trait Implementations

impl<T: Copy + Debug> Debug for LoopCell<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for LoopCell<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for LoopCell<T>

fn from(value: T) -> Self

Converts to this type from the input type.