Struct tokio::fs::ReadDir

pub struct ReadDir(/* private fields */);

Reads the entries in a directory.

This struct is returned from the read_dir function of this module and will yield instances of DirEntry. Through a DirEntry information like the entry’s path and possibly other metadata can be learned.

A ReadDir can be turned into a Stream with ReadDirStream.

Errors

This stream will return an Err if there’s some sort of intermittent IO error during iteration.

Implementations

impl ReadDir

pub async fn next_entry(&mut self) -> Result<Option<DirEntry>>

Returns the next entry in the directory stream.

Cancel safety

This method is cancellation safe.

pub fn poll_next_entry( &mut self, cx: &mut Context<'_> ) -> Poll<Result<Option<DirEntry>>>

Polls for the next directory entry in the stream.

This method returns:

• Poll::Pending if the next directory entry is not yet available.
• Poll::Ready(Ok(Some(entry))) if the next directory entry is available.
• Poll::Ready(Ok(None)) if there are no more directory entries in this stream.
• Poll::Ready(Err(err)) if an IO error occurred while reading the next directory entry.

When the method returns Poll::Pending, the Waker in the provided Context is scheduled to receive a wakeup when the next directory entry becomes available on the underlying IO resource.

Note that on multiple calls to poll_next_entry, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

Trait Implementations

impl Debug for ReadDir

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

Formats the value using the given formatter.