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::Pendingif 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,
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> BorrowMut<T> for Twhere T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Instrument for T
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> WithSubscriber for T
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/io/struct.Split.html