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

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

    pub struct Metadata(_);

Metadata information about a file.

This structure is returned from the `metadata` or `symlink_metadata` function or method and represents known metadata about a file such as its permissions, size, modification times, etc.

## Methods

### `impl Metadata`
[src]

#### `fn file_type(&self) -> FileType`
1.1.0

Returns the file type for this metadata.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    println!("{:?}", metadata.file_type());Run

#### `fn is_dir(&self) -> bool`

Returns whether this metadata is for a directory.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    assert!(!metadata.is_dir());Run

#### `fn is_file(&self) -> bool`

Returns whether this metadata is for a regular file.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    assert!(metadata.is_file());Run

#### `fn len(&self) -> u64`

Returns the size of the file, in bytes, this metadata is for.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    assert_eq!(0, metadata.len());Run

#### `fn permissions(&self) -> Permissions`

Returns the permissions of the file this metadata is for.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    assert!(!metadata.permissions().readonly());Run

#### `fn modified(&self) -> Result<SystemTime>`
1.10.0

Returns the last modification time listed in this metadata.

The returned value corresponds to the `mtime` field of `stat` on Unix platforms and the `ftLastWriteTime` field on Windows platforms.

# Errors

This field may not be available on all platforms, and will return an `Err` on platforms where it is not available.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    if let Ok(time) = metadata.modified() {
        println!("{:?}", time);
    } else {
        println!("Not supported on this platform");
    }Run

#### `fn accessed(&self) -> Result<SystemTime>`
1.10.0

Returns the last access time of this metadata.

The returned value corresponds to the `atime` field of `stat` on Unix platforms and the `ftLastAccessTime` field on Windows platforms.

Note that not all platforms will keep this field update in a file's metadata, for example Windows has an option to disable updating this time when files are accessed and Linux similarly has `noatime`.

# Errors

This field may not be available on all platforms, and will return an `Err` on platforms where it is not available.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    if let Ok(time) = metadata.accessed() {
        println!("{:?}", time);
    } else {
        println!("Not supported on this platform");
    }Run

#### `fn created(&self) -> Result<SystemTime>`
1.10.0

Returns the creation time listed in the this metadata.

The returned value corresponds to the `birthtime` field of `stat` on Unix platforms and the `ftCreationTime` field on Windows platforms.

# Errors

This field may not be available on all platforms, and will return an `Err` on platforms where it is not available.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    if let Ok(time) = metadata.created() {
        println!("{:?}", time);
    } else {
        println!("Not supported on this platform");
    }Run

## Trait Implementations

### `impl Clone for Metadata`
[src]

#### `fn clone(&self) -> Metadata`

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`

Performs copy-assignment from `source`. Read more

### `impl Debug for Metadata`
1.15.0
[src]

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

Formats the value using the given formatter.

### `impl MetadataExt for Metadata`
1.1.0
[src]

#### `fn as_raw_stat(&self) -> &stat`

Deprecated since 1.8.0

: deprecated in favor of the accessor methods of this trait

Gain a reference to the underlying `stat` structure which contains the raw information returned by the OS. Read more

#### `fn st_dev(&self) -> u64`

#### `fn st_ino(&self) -> u64`

#### `fn st_mode(&self) -> u32`

#### `fn st_nlink(&self) -> u64`

#### `fn st_uid(&self) -> u32`

#### `fn st_gid(&self) -> u32`

#### `fn st_rdev(&self) -> u64`

#### `fn st_size(&self) -> u64`

#### `fn st_atime(&self) -> i64`

#### `fn st_atime_nsec(&self) -> i64`

#### `fn st_mtime(&self) -> i64`

#### `fn st_mtime_nsec(&self) -> i64`

#### `fn st_ctime(&self) -> i64`

#### `fn st_ctime_nsec(&self) -> i64`

#### `fn st_birthtime(&self) -> i64`

#### `fn st_birthtime_nsec(&self) -> i64`

#### `fn st_blksize(&self) -> u64`

#### `fn st_blocks(&self) -> u64`

#### `fn st_gen(&self) -> u32`

#### `fn st_flags(&self) -> u32`

### `impl MetadataExt for Metadata`
1.1.0
[src]

#### `fn dev(&self) -> u64`

#### `fn ino(&self) -> u64`

#### `fn mode(&self) -> u32`

#### `fn nlink(&self) -> u64`

#### `fn uid(&self) -> u32`

#### `fn gid(&self) -> u32`

#### `fn rdev(&self) -> u64`

#### `fn size(&self) -> u64`

#### `fn atime(&self) -> i64`

#### `fn atime_nsec(&self) -> i64`

#### `fn mtime(&self) -> i64`

#### `fn mtime_nsec(&self) -> i64`

#### `fn ctime(&self) -> i64`

#### `fn ctime_nsec(&self) -> i64`

#### `fn blksize(&self) -> u64`

#### `fn blocks(&self) -> u64`

# 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`)