[][src]Struct tokio::io::Lines

#[must_use = "streams do nothing unless polled"]pub struct Lines<R> { /* fields omitted */ }
This is supported on feature="io-util" only.

Stream for the lines method.

Implementations

impl<R> Lines<R> where
    R: AsyncBufRead + Unpin
[src]

pub async fn next_line<'_>(&'_ mut self) -> Result<Option<String>>[src]

This is supported on feature="io-util" only.

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[src]

This is supported on feature="io-util" only.

Obtain a mutable reference to the underlying reader

pub fn get_ref(&mut self) -> &R[src]

This is supported on feature="io-util" only.

Obtain a reference to the underlying reader

pub fn into_inner(self) -> R[src]

This is supported on feature="io-util" only.

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>[src]

impl<R: AsyncBufRead> Stream for Lines<R>[src]

type Item = Result<String>

Values yielded by the stream.

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

Auto Trait Implementations

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future