Struct Split

#[must_use = "streams do nothing unless polled"]
pub struct Split<R> { /* private fields */ }

Splitter for the split method.

A Split can be turned into a Stream with SplitStream.

Implementations

impl<R> Split<R> where R: AsyncBufRead + Unpin,

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

Returns the next segment in the stream.

Examples

# use tokio::io::AsyncBufRead;
use tokio::io::AsyncBufReadExt;

# async fn dox(my_buf_read: impl AsyncBufRead + Unpin) -> std::io::Result<()> {
let mut segments = my_buf_read.split(b'f');

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

impl<R> Split<R> where R: AsyncBufRead,

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<'__pin, R> Unpin for Split<R> where PinnedFieldsOf<__Origin<'__pin, R>>: Unpin,

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

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

Auto Trait Implementations

impl<R> Freeze for Split<R> where R: Freeze,

impl<R> RefUnwindSafe for Split<R> where R: RefUnwindSafe,

impl<R> Send for Split<R> where R: Send,

impl<R> Sync for Split<R> where R: Sync,

impl<R> UnsafeUnpin for Split<R> where R: UnsafeUnpin,

impl<R> UnwindSafe for Split<R> where R: UnwindSafe,

Blanket Implementations

impl<T> Any for Split<R> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Split<R> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Split<R> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for Split<R>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Split<R> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Split<R> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Split<R> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>