Struct ByteStream 

pub struct ByteStream { /* private fields */ }

Platform-agnostic byte stream abstraction

Implementations

impl ByteStream

pub fn new<S>(stream: S) -> Self

where S: Stream<Item = Result<Bytes, StreamError>> + Unpin + Send + 'static,

Create a new byte stream from any compatible stream

pub fn is_empty(&self) -> bool

Check if stream is known to be empty (always false for dynamic streams)

pub fn into_inner( self, ) -> Pin<Box<dyn Stream<Item = Result<Bytes, StreamError>> + Send>>

Convert into the inner boxed stream

pub fn tee(self) -> (ByteStream, ByteStream)

Split this stream into two streams that both receive all chunks

Chunks are cloned (cheaply via Bytes rc). Spawns a forwarder task. Both returned streams will receive all chunks from the original stream. The forwarder continues as long as at least one stream is alive. If the underlying stream errors, both teed streams will end.

Trait Implementations

impl Debug for ByteStream

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

Formats the value using the given formatter.