[][src]Struct walkdir::DirEntry

pub struct DirEntry { /* fields omitted */ }

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.

Methods

impl DirEntry
[src]

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.

The full path that this entry represents.

Analogous to path, but moves ownership of the path.

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()).

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.

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.

Return the file name of this entry.

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

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.

Trait Implementations

impl DirEntryExt for DirEntry
[src]

Returns the underlying d_ino field in the contained dirent structure.

impl Clone for DirEntry
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Debug for DirEntry
[src]

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl Send for DirEntry

impl Sync for DirEntry

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more