Struct WalkEntry 

pub struct WalkEntry { /* private fields */ }

Available on crate feature fs only.

A single entry produced by a Walk.

Provides access to the entry’s path, its depth relative to the walk root, its file_type, and lazily-read metadata.

Implementations

impl WalkEntry

pub fn root(&self) -> &Path

Get the root of the walk

pub fn depth(&self) -> usize

Get the depth of this entry, 0 is root, 1 is an entry in the root, etc.

pub fn path(&self) -> &Path

Get the path by joining the walk root and the relative path of the entry

pub fn rel_path(&self) -> Result<PathBuf>

Get this entry’s path relative to the walk root, without a leading ./.

Returns Ok(None) when the entry is the root of the walk (only emitted when include_dir_entries is enabled). Returns an error if the entry path is unexpectedly not contained within the walk root.

for entry in cu::fs::walk("src")? {
    let entry = entry?;
    cu::info!("{}", entry.rel_path()?.display());
}

pub fn file_type(&self) -> FileType

Get the file type

pub fn is_file(&self) -> bool

Check if the entry is a file.

pub fn is_dir(&self) -> bool

Check if the entry is a directory.

pub fn is_symlink(&self) -> bool

Check if the entry is a symlink.

pub fn file_name(&self) -> Option<&OsStr>

Get the file name

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

Get the entry metadata

Trait Implementations

impl Debug for WalkEntry

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

Formats the value using the given formatter.