Struct Split

pub struct Split<R> { /* private fields */ }

Available on crate feature io-util only.

Splitter for the split method.

A Split can be turned into a Stream with SplitStream.

Implementations

impl<R> Split<R>

where R: AsyncBufRead + Unpin,

pub async fn next_segment(&mut self) -> Result<Option<Vec<u8>>>

Returns the next segment in the stream.

Examples

use tokio::io::AsyncBufReadExt;

let mut segments = my_buf_read.split(b'f');

while let Some(segment) = segments.next_segment().await? {
    println!("length = {}", segment.len())
}

impl<R> Split<R>

where R: AsyncBufRead,

pub fn poll_next_segment( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<Option<Vec<u8>>>>

Polls for the next segment in the stream.

This method returns:

• Poll::Pending if the next segment is not yet available.
• Poll::Ready(Ok(Some(segment))) if the next segment is available.
• Poll::Ready(Ok(None)) if there are no more segments in this stream.
• Poll::Ready(Err(err)) if an IO error occurred while reading the next segment.

When the method returns Poll::Pending, the Waker in the provided Context is scheduled to receive a wakeup when more bytes become available on the underlying IO resource.

Note that on multiple calls to poll_next_segment, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

Trait Implementations

impl<R: Debug> Debug for Split<R>

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

Formats the value using the given formatter.

impl<'__pin, R> Unpin for Split<R>

where PinnedFieldsOf<__Origin<'__pin, R>>: Unpin,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.