pub struct DirEntry(_);
Expand description

An entry in a directory.

A stream of entries in a directory is returned by [read_dir()].

For Unix-specific options, import the DirEntryExt trait.

Implementations

Returns the full path to this entry.

The full path is created by joining the original path passed to [read_dir()] with the name of this entry.

Examples
use futures_lite::stream::StreamExt;

let mut dir = async_fs::read_dir(".").await?;

while let Some(entry) = dir.try_next().await? {
    println!("{:?}", entry.path());
}

Reads the metadata for this entry.

This function will traverse symbolic links to read the metadata.

If you want to read metadata without following symbolic links, use [symlink_metadata()] instead.

Errors

An error will be returned in the following situations:

  • This entry does not point to an existing file or directory anymore.
  • The current process lacks permissions to read the metadata.
  • Some other I/O error occurred.
Examples
use futures_lite::stream::StreamExt;

let mut dir = async_fs::read_dir(".").await?;

while let Some(entry) = dir.try_next().await? {
    println!("{:?}", entry.metadata().await?);
}

Reads the file type for this entry.

This function will not traverse symbolic links if this entry points at one.

If you want to read metadata with following symbolic links, use [metadata()] instead.

Errors

An error will be returned in the following situations:

  • This entry does not point to an existing file or directory anymore.
  • The current process lacks permissions to read this entry’s metadata.
  • Some other I/O error occurred.
Examples
use futures_lite::stream::StreamExt;

let mut dir = async_fs::read_dir(".").await?;

while let Some(entry) = dir.try_next().await? {
    println!("{:?}", entry.file_type().await?);
}

Returns the bare name of this entry without the leading path.

Examples
use futures_lite::stream::StreamExt;

let mut dir = async_fs::read_dir(".").await?;

while let Some(entry) = dir.try_next().await? {
    println!("{}", entry.file_name().to_string_lossy());
}

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the underlying d_ino field in the contained dirent structure. 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.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
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.