Struct tokio::io::Split

[+] Show declaration

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

[−] Expand description

Stream for the split method.

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

Trait Implementations

impl<R: Debug> Debug for Split<R>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<R: AsyncBufRead> Stream for Split<R>[+]

[+] Show hidden undocumented items

type Item = Result<Vec<u8>>

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.

pub fn size_hint(&self) -> (usize, Option<usize>)[−]

Returns the bounds on the remaining length of the stream.

impl<'__pin, R> Unpin for Split<R> where
    __Origin<'__pin, R>: Unpin,