Struct tokio_stream::wrappers::ReadDirStream

pub struct ReadDirStream { /* fields omitted */ }

This is supported on crate feature fs only.

A wrapper around tokio::fs::ReadDir that implements Stream.

Implementations

impl ReadDirStream

pub fn new(read_dir: ReadDir) -> Self

Create a new ReadDirStream.

pub fn into_inner(self) -> ReadDir

Get back the inner ReadDir.

Trait Implementations

impl AsMut<ReadDir> for ReadDirStream

fn as_mut(&mut self) -> &mut ReadDir

Performs the conversion.

impl AsRef<ReadDir> for ReadDirStream

fn as_ref(&self) -> &ReadDir

Performs the conversion.

impl Debug for ReadDirStream

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

Formats the value using the given formatter.

impl Stream for ReadDirStream

type Item = Result<DirEntry>

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.

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

Returns the bounds on the remaining length of the stream.