Struct DirEntry

pub struct DirEntry { /* private fields */ }

Entries returned by the ReadDir iterator.

This corresponds to async_std::fs::DirEntry.

Unlike async_std::fs::DirEntry, this API has no DirEntry::path, because absolute paths don’t interoperate well with the capability model.

There is a file_name function, however there are also open, open_with, open_dir, remove_file, and remove_dir functions for opening or removing the entry directly, which can be more efficient and convenient.

There is no from_std method, as async_std::fs::DirEntry doesn’t provide a way to construct a DirEntry without opening directories by ambient paths.

TODO: async

Implementations

impl DirEntry

pub fn open(&self) -> Result<File>

Open the file for reading.

pub fn open_with(&self, options: &OpenOptions) -> Result<File>

Open the file with the given options.

pub fn open_dir(&self) -> Result<Dir>

Open the entry as a directory.

pub fn remove_file(&self) -> Result<()>

Removes the file from its filesystem.

pub fn remove_dir(&self) -> Result<()>

Removes the directory from its filesystem.

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

Returns the metadata for the file that this entry points at.

This corresponds to async_std::fs::DirEntry::metadata.

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

Returns the file type for the file that this entry points at.

This corresponds to async_std::fs::DirEntry::file_type.

pub fn file_name(&self) -> OsString

Returns the bare file name of this directory entry without any other leading path component.

This corresponds to async_std::fs::DirEntry::file_name.

Trait Implementations

impl Debug for DirEntry

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

Formats the value using the given formatter.