Struct jwalk::DirEntry

pub struct DirEntry {
    pub depth: usize,
    pub file_name: OsString,
    pub file_type: Result<FileType>,
    pub metadata: Option<Result<Metadata>>,
    pub content_spec: Option<Arc<ReadDirSpec>>,
    pub content_error: Option<Error>,
    pub parent_spec: Option<Arc<ReadDirSpec>>,
}

Representation of a file or directory.

This representation does not wrap a std::fs::DirEntry. Instead it copies file_name, file_type, and optionaly metadata out of the underlying std::fs::DirEntry. This allows it to quickly drop the underlying file descriptor.

Fields

depth: usize

Depth of this entry relative to the root directory where the walk started.

file_name: OsString

File name of this entry without leading path component.

file_type: Result<FileType>

File type result for the file/directory that this entry points at.

metadata: Option<Result<Metadata>>

Metadata result for the file/directory that this entry points at. Defaults to None. Filled in by the walk process when the preload_metadata option is set.

content_spec: Option<Arc<ReadDirSpec>>

ReadDirSpec used for reading this entry's content. This is automatically set for directory entries. The process_entries callback may set this field to None to skip reading the contents of this particular directory.

content_error: Option<Error>

If fs::read_dir generates an error when reading this entry's content then that error is stored here.

parent_spec: Option<Arc<ReadDirSpec>>

ReadDirSpec used by this entry's parent to read this entry.

Methods

impl DirEntry

pub fn path(&self) -> PathBuf

Path to the file/directory represented by this entry.

The path is created by joining parent_path with file_name.

pub fn parent_path(&self) -> Option<&Path>

Reference to the path of the directory containing this entry.

Trait Implementations

impl Debug for DirEntry

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

Formats the value using the given formatter.