Struct DelimiterSlice 

pub struct DelimiterSlice<St, D> { /* private fields */ }

Implementations

impl<St, D> DelimiterSlice<St, D>

pub fn new(stream: St, delimiter: D) -> Self

Create a new DelimiterSlice based on the provided stream and delimiter.

This defaults instantiating the underlying buffer with a capacity of 8,192 bytes.

pub fn with_capacity(stream: St, delimiter: D, capacity: usize) -> Self

pub fn with_limit(stream: St, delimiter: D, limit: usize) -> Self

pub fn with_capacity_and_limit( stream: St, delimiter: D, capacity: usize, limit: usize, ) -> Self

pub fn into_inner(self) -> St

Return the wrapped stream.

This is useful once the delimiter has been returned and the internal buffer has been cleared by calling next() again.

Panics

Panics if the internal buffer is not empty when this is called. The stated purpose of this library is to provide a simple and safe way to extract data from a delimited stream, but allow the stream to continue producing the data in the order it was received.

If you’ve called into_inner before a second call to next this is likely an error.

Trait Implementations

impl<St: Debug, D: Debug> Debug for DelimiterSlice<St, D>

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

Formats the value using the given formatter.

impl<St, D> Stream for DelimiterSlice<St, D>

where D: AsRef<[u8]>, St: Stream<Item = Result<Bytes, Error>>,

type Item = Result<Bytes, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<St::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.

impl<'__pin, St, D> Unpin for DelimiterSlice<St, D>

where PinnedFieldsOf<__Origin<'__pin, St, D>>: Unpin,