Struct tokio::io::Lines

source ·
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,

source

pub async fn next_line(&mut self) -> Result<Option<String>>

Returns the next line in the stream.

§Cancel safety

This method is cancellation safe.

§Examples
use tokio::io::AsyncBufReadExt;

let mut lines = my_buf_read.lines();

while let Some(line) = lines.next_line().await? {
    println!("length = {}", line.len())
}
source

pub fn get_mut(&mut self) -> &mut R

Obtains a mutable reference to the underlying reader.

source

pub fn get_ref(&mut self) -> &R

Obtains a reference to the underlying reader.

source

pub fn into_inner(self) -> R

Unwraps 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.

source§

impl<R> Lines<R>
where R: AsyncBufRead,

source

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§

source§

impl<R: Debug> Debug for Lines<R>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.