Struct tokio::io::Lines

#[must_use = "streams do nothing unless polled"]pub struct Lines<R> { /* fields omitted */ }

Stream for the lines method.

Implementations

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

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

Returns the next line in the stream.

Examples

use tokio::io::AsyncBufReadExt;

let mut lines = my_buf_read.lines();

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

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

Obtain a mutable reference to the underlying reader

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

Obtain a reference to the underlying reader

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.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<R: AsyncBufRead> Stream for Lines<R>

type Item = Result<String>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, R> Unpin for Lines<R> where
    __Origin<'__pin, R>: Unpin,