std::fs::DirEntry - Rust
Description: API documentation for the Rust `DirEntry` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, DirEntry

# Struct std::fs::DirEntry 1.0.0 [−] [src]

    pub struct DirEntry(_);

Entries returned by the `ReadDir` iterator.

An instance of `DirEntry` represents an entry inside of a directory on the filesystem. Each entry can be inspected via methods to learn about the full path or possibly other metadata through per-platform extension traits.

## Methods

### `impl DirEntry`
[src]

#### `pub fn path(&self) -> PathBuf`
[src]

Returns the full path to the file that this entry represents.

The full path is created by joining the original path to `read_dir` with the filename of this entry.

# Examples

    use std::fs;
    for entry in fs::read_dir(".")? {
        let dir = entry?;
        println!("{:?}", dir.path());
    }Run

This prints output like:

    "./whatever.txt"
    "./foo.html"
    "./hello_world.rs"

The exact text, of course, depends on what files you have in `.`.

#### `pub fn metadata(&self) -> Result<Metadata>`
1.1.0
[src]

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

This function will not traverse symlinks if this entry points at a symlink.

# Platform-specific behavior

On Windows this function is cheap to call (no extra system calls needed), but on Unix platforms this function is the equivalent of calling `symlink_metadata` on the path.

# Examples

    use std::fs;

    if let Ok(entries) = fs::read_dir(".") {
        for entry in entries {
            if let Ok(entry) = entry {
                // Here, `entry` is a `DirEntry`.
                if let Ok(metadata) = entry.metadata() {
                    // Now let's show our entry's permissions!
                    println!("{:?}: {:?}", entry.path(), metadata.permissions());
                } else {
                    println!("Couldn't get metadata for {:?}", entry.path());
                }
            }
        }
    }Run

#### `pub fn file_type(&self) -> Result<FileType>`
1.1.0
[src]

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

This function will not traverse symlinks if this entry points at a symlink.

# Platform-specific behavior

On Windows and most Unix platforms this function is free (no extra system calls needed), but some Unix platforms may require the equivalent call to `symlink_metadata` to learn about the target file type.

# Examples

    use std::fs;

    if let Ok(entries) = fs::read_dir(".") {
        for entry in entries {
            if let Ok(entry) = entry {
                // Here, `entry` is a `DirEntry`.
                if let Ok(file_type) = entry.file_type() {
                    // Now let's show our entry's file type!
                    println!("{:?}: {:?}", entry.path(), file_type);
                } else {
                    println!("Couldn't get file type for {:?}", entry.path());
                }
            }
        }
    }Run

#### `pub fn file_name(&self) -> OsString`
1.1.0
[src]

Returns the bare file name of this directory entry without any other leading path component.

# Examples

    use std::fs;

    if let Ok(entries) = fs::read_dir(".") {
        for entry in entries {
            if let Ok(entry) = entry {
                // Here, `entry` is a `DirEntry`.
                println!("{:?}", entry.file_name());
            }
        }
    }Run

## Trait Implementations

### `impl Debug for DirEntry`
1.13.0
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl DirEntryExt for DirEntry`
1.1.0
[src]

#### `fn ino(&self) -> u64`
[src]

This is supported on Unix only.

Returns the underlying `d_ino` field in the contained `dirent` structure. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)