Struct cap_primitives::fs::DirEntry

source · [−]

pub struct DirEntry { /* private fields */ }

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.

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

source

impl DirEntry

source

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

Open the file for reading.

source

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

Open the file with the given options.

source

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

Open the entry as a directory.

source

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

Removes the file from its filesystem.

source

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

Removes the directory from its filesystem.

source

pub fn read_dir(&self) -> Result<ReadDir>

Returns an iterator over the entries within the subdirectory.

source

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

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

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

Platform-specific behavior

On Windows, this produces a Metadata object which does not contain the optional values returned by MetadataExt. Use cap_fs_ext::DirEntryExt::full_metadata to obtain a Metadata with the values filled in.

source