Struct DirEntry

pub struct DirEntry {
    path: PathBuf,
    ty: FileType,
    follow_link: bool,
    depth: usize,
    ino: u64,
}

A directory entry.

This is the type of value that is yielded from the iterators defined in this crate.

On Unix systems, this type implements the DirEntryExt trait, which provides efficient access to the inode number of the directory entry.

Differences with std::fs::DirEntry

This type mostly mirrors the type by the same name in std::fs. There are some differences however:

• All recursive directory iterators must inspect the entry’s type. Therefore, the value is stored and its access is guaranteed to be cheap and successful.
• path and file_name return borrowed variants.
• If follow_links was enabled on the originating iterator, then all operations except for path operate on the link target. Otherwise, all operations operate on the symbolic link.

Fields

path: PathBuf

The path as reported by the fs::ReadDir iterator (even if it’s a symbolic link).

ty: FileType

The file type. Necessary for recursive iteration, so store it.

follow_link: bool

Is set when this entry was created from a symbolic link and the user expects the iterator to follow symbolic links.

depth: usize

The depth at which this entry was generated relative to the root.

ino: u64

The underlying inode number (Unix only).

Implementations

impl DirEntry

pub fn path(&self) -> &Path

The full path that this entry represents.

The full path is created by joining the parents of this entry up to the root initially given to WalkDir::new with the file name of this entry.

Note that this always returns the path reported by the underlying directory entry, even when symbolic links are followed. To get the target path, use path_is_symlink to (cheaply) check if this entry corresponds to a symbolic link, and std::fs::read_link to resolve the target.

pub fn into_path(self) -> PathBuf

The full path that this entry represents.

Analogous to path, but moves ownership of the path.

pub fn path_is_symlink(&self) -> bool

Returns true if and only if this entry was created from a symbolic link. This is unaffected by the follow_links setting.

When true, the value returned by the path method is a symbolic link name. To get the full target path, you must call std::fs::read_link(entry.path()).

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

Return the metadata for the file that this entry points to.

This will follow symbolic links if and only if the WalkDir value has follow_links enabled.

Platform behavior

This always calls std::fs::symlink_metadata.

If this entry is a symbolic link and follow_links is enabled, then std::fs::metadata is called instead.

Errors

Similar to std::fs::metadata, returns errors for path values that the program does not have permissions to access or if the path does not exist.

fn metadata_internal(&self) -> Result<Metadata>

pub fn file_type(&self) -> FileType

Return the file type for the file that this entry points to.

If this is a symbolic link and follow_links is true, then this returns the type of the target.

This never makes any system calls.

pub fn file_name(&self) -> &OsStr

Return the file name of this entry.

If this entry has no file name (e.g., /), then the full path is returned.

pub fn depth(&self) -> usize

Returns the depth at which this entry was created relative to the root.

The smallest depth is 0 and always corresponds to the path given to the new function on WalkDir. Its direct descendents have depth 1, and their descendents have depth 2, and so on.

pub(crate) fn is_dir(&self) -> bool

Returns true if and only if this entry points to a directory.

pub(crate) fn from_entry(depth: usize, ent: &DirEntry) -> Result<DirEntry>

pub(crate) fn from_path( depth: usize, pb: PathBuf, follow: bool, ) -> Result<DirEntry>

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

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.