Struct Weak 

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

A weak reference to a Producer/Consumer state.

Does not affect ref counts, so it won’t prevent auto-close when all Producers are dropped. Can be upgraded to a full Producer or Consumer.

Implementations

impl<T> Weak<T>

pub fn produce(&self) -> Option<Producer<T>>

Upgrade to a Producer, returning None if the channel is already closed.

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

Create a new Consumer that shares this state.

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

Acquire mutable access to the shared state without upgrading to a full Producer.

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

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

Get read-only access to the shared state.

pub fn poll_write<F, R>(&self, waiter: &Waiter, f: F) -> Poll<Option<R>>

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 None 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 fn is_closed(&self) -> bool

Returns true if the channel has been 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 same_channel(&self, other: &Self) -> bool

Returns true if both weak references share the same underlying state.

Trait Implementations

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

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

Formats the value using the given formatter.