Struct tokio::fs::ReadDir

source ·
pub struct ReadDir(_);
Available on crate feature fs only.
Expand description

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§

source

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.

source

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§

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more