Struct cap_std::fs::DirEntry

pub struct DirEntry { /* private fields */ }

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.

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.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 36)

    pub fn open(&self) -> io::Result<File> {
        self.cap_std.open().map(File::from_cap_std)
    }

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

Open the file with the given options.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 42)

    pub fn open_with(&self, options: &OpenOptions) -> io::Result<File> {
        self.cap_std.open_with(options).map(File::from_cap_std)
    }

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

Open the entry as a directory.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 48)

    pub fn open_dir(&self) -> io::Result<Dir> {
        self.cap_std.open_dir().map(Dir::from_cap_std)
    }

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

Removes the file from its filesystem.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 54)

    pub fn remove_file(&self) -> io::Result<()> {
        self.cap_std.remove_file()
    }

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

Removes the directory from its filesystem.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 60)

    pub fn remove_dir(&self) -> io::Result<()> {
        self.cap_std.remove_dir()
    }

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

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

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

Examples found in repository

src/fs_utf8/dir_entry.rs (line 68)

    pub fn metadata(&self) -> io::Result<Metadata> {
        self.cap_std.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.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 76)

    pub fn file_type(&self) -> io::Result<FileType> {
        self.cap_std.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.

Examples found in repository

src/fs_utf8/dir_entry.rs (line 91)

    pub fn file_name(&self) -> io::Result<String> {
        Ok(to_utf8(self.cap_std.file_name())?.into())
    }

Trait Implementations

impl Debug for DirEntry

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

Formats the value using the given formatter.

impl DirEntryExt for DirEntry

Available on non-Windows only.

fn ino(&self) -> u64

Returns the underlying d_ino field in the contained dirent structure.