Struct Producer 

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

The producing side of a shared state channel.

Producers hold mutable access to the shared value. When the state is modified through Mut, all registered consumers are automatically notified. Cloning a producer increments the producer reference count. When the last producer is dropped, the channel is closed.

Implementations

impl<T> Producer<T>

pub fn new(value: T) -> Self

Create a new producer with the given initial value.

pub fn consume(&self) -> Consumer<T>

Create a new Consumer that shares this producer’s state.

pub fn close(&self) -> Result<(), Ref<'_, T>>

Close the channel, notifying all consumers.

pub fn write(&self) -> Result<Mut<'_, T>, Ref<'_, T>>

Acquire mutable access to the shared state.

Returns Ok(Mut) if the channel is open, or Err(Ref) with read-only access if closed. Only locks once.

pub fn poll<F, R>(&self, waiter: &Waiter, f: F) -> Poll<Result<R, Ref<'_, T>>>

where F: FnMut(&mut Mut<'_, T>) -> Poll<R>,

Poll-based mutable access with waker registration.

Calls f with a Mut guard. If f returns Poll::Pending, registers the Waiter for notification when the state next changes. Returns Poll::Ready(Err(Ref)) if the channel is closed.

pub async fn wait<F, R>(&self, f: F) -> Result<R, Ref<'_, T>>

where F: FnMut(&mut Mut<'_, T>) -> Poll<R> + Unpin, R: Unpin,

Wait for the closure to return Poll::Ready, re-polling on each state change.

Returns Ok(R) when the closure returns Poll::Ready, or Err(Ref) with read-only access to the final state if the channel closes first.

pub async fn closed(&self)

Wait until the channel is closed.

pub async fn unused(&self) -> Result<(), Ref<'_, T>>

Wait until all consumers have been dropped.

Returns Ok(()) when no consumers remain, or Err(Ref) if the channel closes first.

pub fn read(&self) -> Ref<'_, T>

Get read-only access to the shared state.

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

Returns true if both producers share the same underlying state.

pub fn weak(&self) -> Weak<T>

Create a Weak reference that doesn’t affect the producer/consumer ref counts.

Trait Implementations

impl<T> Clone for Producer<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 Producer<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Producer<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for Producer<T>

fn drop(&mut self)

Executes the destructor for this type.