Struct tokio::io::Split[][src]

pub struct Split<R> { /* fields omitted */ }
Expand description

Splitter for the split method.

A Split can be turned into a Stream with SplitStream.

Implementations

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())
}

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.