Struct Sender 

pub struct Sender<E> { /* private fields */ }

Sender side of the byte stream.

Clones share one readiness registration. If several clones poll readiness, the most recently registered task is the one that will be woken.

Implementations

impl<E> Sender<E>

pub fn is_closed(&self) -> bool

Returns true if the receiver has been dropped.

pub fn set_error(&self, err: E)

Stores a terminal stream error and wakes both sides.

pub fn feed_eof(&self)

Marks the stream as EOF and wakes both sides.

pub fn feed_data(&self, data: Bytes)

Adds a chunk to the stream.

This method does not enforce the configured backpressure threshold.

pub async fn ready(&self) -> Status

Waits until the stream needs more data or reaches a terminal state.

pub fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<Status>

Polls until the stream needs more data or reaches a terminal state.

Terminal states take precedence: Status::Dropped is returned once the receiver is gone or an error was set, Status::Eof after EOF.

Trait Implementations

impl<E> Clone for Sender<E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Sender<E>

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

Formats the value using the given formatter.

impl<E> Drop for Sender<E>

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.