Struct Lines
#[must_use = "streams do nothing unless polled"]
pub struct Lines<R> { /* private fields */ }
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
impl<R> Lines<R>
where
R: AsyncBufRead + Unpin,
async fn next_line(&mut self) -> Result<Option<String>>Returns the next line in the stream.
Cancel safety
This method is cancel safe.
Examples
# use AsyncBufRead; use AsyncBufReadExt; # asyncfn get_mut(&mut self) -> &mut RObtains a mutable reference to the underlying reader.
fn get_ref(&mut self) -> &RObtains a reference to the underlying reader.
fn into_inner(self) -> RUnwraps this
Lines<R>, returning the underlying reader.Note that any leftover data in the internal buffer is lost. Therefore, a following read from the underlying reader may lead to data loss.
impl<R> Lines<R>
where
R: AsyncBufRead,
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::Pendingif 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, theWakerin the providedContextis scheduled to receive a wakeup when more bytes become available on the underlying IO resource. Note that on multiple calls topoll_next_line, only theWakerfrom theContextpassed 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,
impl<R: Debug> Debug for Lines<R>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
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> UnsafeUnpin for Lines<R>
where
R: UnsafeUnpin,
impl<R> UnwindSafe for Lines<R>
where
R: UnwindSafe,
Blanket Implementations
impl<T> Any for Lines<R>
where
T: 'static + ?Sized,
fn type_id(&self) -> TypeId
impl<T> Borrow<T> for Lines<R>
where
T: ?Sized,
fn borrow(&self) -> &T
impl<T> BorrowMut<T> for Lines<R>
where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
impl<T> From<T> for Lines<R>
fn from(t: T) -> TReturns the argument unchanged.
impl<T, U> Into<U> for Lines<R>
where
U: From<T>,
fn into(self) -> UCalls
U::from(self).That is, this conversion is whatever the implementation of
[From]<T> for Uchooses to do.
impl<T, U> TryFrom<U> for Lines<R>
where
U: Into<T>,
type Error = never;fn try_from(value: U) -> Result<T, never>
impl<T, U> TryInto<U> for Lines<R>
where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error;fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>