pub struct Split<R> { /* private fields */ }
Expand description
Splitter for the split
method.
A Split
can be turned into a Stream
with SplitStream
.
Implementations
sourceimpl<R> Split<R> where
R: AsyncBufRead + Unpin,
impl<R> Split<R> where
R: AsyncBufRead + Unpin,
sourceimpl<R> Split<R> where
R: AsyncBufRead,
impl<R> Split<R> where
R: AsyncBufRead,
sourcepub fn poll_next_segment(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<Vec<u8>>>>
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::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
__Origin<'__pin, R>: Unpin,
Auto Trait Implementations
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> UnwindSafe for Split<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more