Struct DirEntry

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

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

impl DirEntry

pub fn path(&self) -> PathBuf

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());
}

pub async fn metadata(&self) -> Result<Metadata, Error>

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?);
}

pub async fn file_type(&self) -> Result<FileType, Error>

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?);
}

pub fn file_name(&self) -> OsString

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

impl Clone for DirEntry

fn clone(&self) -> DirEntry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DirEntry

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

Formats the value using the given formatter.

impl DirEntryExt for DirEntry

fn ino(&self) -> u64

Returns the underlying d_ino field in the contained dirent structure.