Struct StoreLock 

pub struct StoreLock<T: ?Sized>(/* private fields */);

Records messages delivered via Listener by mutating a value which implements Store.

This value is referred to as the “state”, and it is kept inside a mutex.

Generic parameters

• T is the type of the state, which should implement Store.

Implementations

impl<T> StoreLock<T>

pub fn new(initial_state: T) -> Self

Construct a new StoreLock with the given initial state.

impl<T: ?Sized> StoreLock<T>

pub fn listener(&self) -> StoreLockListener<T>

Returns a Listener which delivers messages to this.

pub fn lock(&self) -> impl DerefMut<Target = T> + use<'_, T>

Locks and returns access to the state.

Callers should be careful to hold the lock for a very short time (e.g. only to copy or take the data) or to do so only while messages will not be arriving. Otherwise, poor performance or deadlock may result.

Panics

If it is called while the same thread has already acquired the lock, it may panic or hang, depending on the mutex implementation in use.

pub fn take(&self) -> T

where T: Sized + Default,

Replaces the current state with T::default() and returns it.

This is not more powerful than lock(), but it offers the guarantee that it will hold the lock for as little time as possible. It is equivalent to:

let replacement = T::default();
mem::replace(&mut *self.lock(), replacement)

Panics

If it is called while the same thread has already acquired the lock, it may panic or hang, depending on the mutex implementation in use.

pub fn receive<M>(&self, messages: &[M])

where T: Store<M>,

Delivers messages like self.listener().receive(messages), but without creating a temporary listener.

Panics

If it is called while the same thread has already acquired the lock, it may panic or hang, depending on the mutex implementation in use.

Trait Implementations

impl<T: ?Sized + Debug> Debug for StoreLock<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for StoreLock<T>

fn default() -> StoreLock<T>

Returns the “default value” for a type.

impl<T: ?Sized> Pointer for StoreLock<T>

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

Produces an address which is the same for this StoreLock and its associated StoreLockListeners.