pub struct Lines<R> { /* private fields */ }
Expand description
Reads lines from an AsyncBufRead
.
A Lines
can be turned into a Stream
with LinesStream
.
This type is usually created using the lines
method.
Implementations§
source§impl<R> Lines<R>where
R: AsyncBufRead + Unpin,
impl<R> Lines<R>where
R: AsyncBufRead + Unpin,
source§impl<R> Lines<R>where
R: AsyncBufRead,
impl<R> Lines<R>where
R: AsyncBufRead,
sourcepub fn poll_next_line(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<Option<String>>>
pub fn poll_next_line( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<Option<String>>>
Polls for the next line in the stream.
This method returns:
Poll::Pending
if the next line is not yet available.Poll::Ready(Ok(Some(line)))
if the next line is available.Poll::Ready(Ok(None))
if there are no more lines in this stream.Poll::Ready(Err(err))
if an IO error occurred while reading the next line.
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_line
, 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 Lines<R>where
PinnedFieldsOf<__Origin<'__pin, R>>: Unpin,
Auto Trait Implementations§
impl<R> Freeze for Lines<R>where
R: Freeze,
impl<R> RefUnwindSafe for Lines<R>where
R: RefUnwindSafe,
impl<R> Send for Lines<R>where
R: Send,
impl<R> Sync for Lines<R>where
R: Sync,
impl<R> UnwindSafe for Lines<R>where
R: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more