Struct ChunkChannel 

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

The producing half of a chunked byte stream.

Held by whatever is doing the blocking read. Dropping it without calling ChunkChannel::finish or ChunkChannel::fail ends the stream, so a worker that panics does not leave a reader waiting for ever.

Implementations

impl<E> ChunkChannel<E>

pub fn new() -> (Self, ChunkStream<E>)

Creates a channel and its reading half.

pub fn push(&self, chunk: Vec<u8>) -> bool

Publishes one chunk, waiting while the consumer is more than MAX_PENDING_CHUNKS behind.

Returns false once the consumer has gone, which is the producer’s signal to stop reading.

pub fn fail(&self, error: E)

Ends the stream with an error.

pub fn finish(&self)

Ends the stream normally.

pub fn is_abandoned(&self) -> bool

Whether the consumer has gone.

Trait Implementations

impl<E> Drop for ChunkChannel<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.