Struct Payload 

pub struct Payload<T = ()>
where
    T: Send,
{ /* private fields */ }

A globally-registered, cheaply-cloneable slot for handing a value of type T between async tasks and the UI, with an associated pending flag to track in-flight operations. Instances sharing the same id share the same storage.

Implementations

impl<T> Payload<T>

where T: Send + 'static,

pub fn new<S: Display>(id: S) -> Self

Returns the payload registered under id, creating and registering a new empty one if none exists yet, so callers sharing an id share state.

pub fn store(&self, data: T)

Stores a value in the slot, replacing any previously stored value.

pub fn is_pending(&self) -> bool

Returns true if the pending flag is set.

pub fn mark_pending(&self)

Sets the pending flag, indicating an operation is in progress.

pub fn clear_pending(&self)

Clears the pending flag, indicating no operation is in progress.

pub fn is_some(&self) -> bool

Returns true if a value is currently stored in the slot.

pub fn take(&self) -> Option<T>

Removes and returns the stored value, clearing the pending flag, or returns None if the slot is empty.

pub fn inner_clone(&self) -> Option<T>

where T: Clone,

Returns a clone of the stored value without removing it, or None if the slot is empty.

Trait Implementations

impl<T> Clone for Payload<T>

where T: Send,

fn clone(&self) -> Payload<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.