Struct ByteChunker

pub struct ByteChunker<R: AsyncRead> { /* private fields */ }

Available on crate feature async only.

The stream::ByteChunker is the async analog to the base ByteChunker type. It wraps an AsyncReader and implements the Stream trait.

This async version of the base ByteChunker is less flexible in how it handles errors; you’ll get errors when Tokio’s underlying black magic returns them.

Implementations

impl<R: AsyncRead> ByteChunker<R>

pub fn new(source: R, pattern: &str) -> Result<Self, RcErr>

Return a new ByteChunker wrapping the given async reader that will chunk its output be delimiting it with the given regular expression pattern.

pub fn with_adapter<A>(self, adapter: A) -> CustomChunker<R, A>

pub fn with_match(self, behavior: MatchDisposition) -> Self

Builder-pattern for controlling what the chunker does with the matched text; default value is MatchDisposition::Drop.

Trait Implementations

impl<A: AsyncRead + Unpin> Stream for ByteChunker<A>

type Item = Result<Vec<u8>, RcErr>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.