# tokio::io::Split - Rust
API documentation for the Rust `Split` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, Split

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

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

Splitter for the `split` method.

A `Split` can be turned into a `Stream` with `SplitStream`.

## Implementations

### `impl<R> Split<R> where
R: AsyncBufRead + Unpin,` [src]

#### `pub async fn next_segment(&mut self) -> Result<Option<Vec<u8>>>` [src]

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,` [src]

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

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>` [src]

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

Formats the value using the given formatter. Read more

### `impl<'__pin, R> Unpin for Split<R> where
__Origin<'__pin, R>: Unpin,` [src]

## Auto Trait Implementations

### `impl<R> RefUnwindSafe for Split<R> where
R: RefUnwindSafe,` [src]

### `impl<R> Send for Split<R> where
R: Send,` [src]

### `impl<R> Sync for Split<R> where
R: Sync,` [src]

### `impl<R> UnwindSafe for Split<R> where
R: UnwindSafe,` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.