Struct cap_std::fs::DirEntry

[+] Show declaration

pub struct DirEntry { /* fields omitted */ }

[−] Expand description

Entries returned by the ReadDir iterator.

This corresponds to std::fs::DirEntry.

Unlike 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.

Note that there is no from_std method, as std::fs::DirEntry doesn't provide a way to construct a DirEntry without opening directories by ambient paths.

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 std::fs::DirEntry::metadata.

pub fn file_type(&self) -> Result<FileType>[−]

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

This corresponds to 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 std::fs::DirEntry::file_name.

Trait Implementations

impl Debug for DirEntry[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl DirEntryExt for DirEntry[+]

[+] Show hidden undocumented items

fn ino(&self) -> u64[−]

Returns the underlying d_ino field in the contained dirent structure.