Struct Channel 

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

A closeable bounded MPSC channel whose consumer side is a Source.

Clone the handle for producers. At most one consumer stream may be active at a time; a second concurrent materialization of the same channel source returns a StreamError. Dropping the active consumer closes the channel so blocked producers wake and future sends fail with SendError::Closed.

Capacity must be greater than zero. FS2’s synchronous/rendezvous bounded(0) mode is deliberately unsupported in this v1 bounded channel.

Implementations

impl<T> Channel<T>

pub fn bounded(capacity: usize) -> Self

Create a bounded channel. Panics if capacity == 0.

pub fn source(&self) -> Source<T>

where T: Send + 'static,

Return a source blueprint attached to this channel.

Materialization claims the one active consumer slot. A concurrent second materialization fails with StreamError::Failed.

pub async fn send(&self, value: T) -> Result<(), SendError<T>>

Asynchronously send one value, waiting without spinning while the buffer is full. Returns SendError::Closed if the channel closes before the value is accepted.

pub fn try_send(&self, value: T) -> Result<(), TrySendError<T>>

Try to enqueue one value without waiting.

pub fn close(&self)

Gracefully close the channel.

Buffered elements remain visible to the consumer and drain before the source completes. The operation is idempotent.

pub fn is_closed(&self) -> bool

Return true after the channel has been closed.

pub async fn closed(&self)

Wait until the channel is closed.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Drop for Channel<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.