Type Alias DirEntry

pub type DirEntry = DirEntryGeneric<((), ())>;

Available on crate feature fs-walkdir-parallel only.

An alias for an uncustomized directory entry to match the one of the non-parallel version offered by walkdir.

Aliased Type

pub struct DirEntry {
    pub depth: usize,
    pub file_name: OsString,
    pub file_type: FileType,
    pub client_state: (),
    pub parent_path: Arc<Path>,
    pub read_children_path: Option<Arc<Path>>,
    pub read_children_error: Option<Error>,
    /* private fields */
}

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: FileType

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

client_state: ()

Field where clients can store state from within the The process_read_dir callback.

parent_path: Arc<Path>

Path used by this entry’s parent to read this entry.

read_children_path: Option<Arc<Path>>

Path that will be used to read child entries. This is automatically set for directories. The process_read_dir callback may set this field to None to skip reading the contents of a particular directory.

read_children_error: Option<Error>

If read_children_path is set and resulting fs::read_dir generates an error then that error is stored here.