W3cubDocs

/Rust

Struct std::fs::Metadata

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]

Returns the file type for this metadata.

Examples

use std::fs;

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

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

Returns whether this metadata is for a directory.

Examples

use std::fs;

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

assert!(!metadata.is_dir());

Returns whether this metadata is for a regular file.

Examples

use std::fs;

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

assert!(metadata.is_file());

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

Returns the permissions of the file this metadata is for.

Examples

use std::fs;

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

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

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");
}

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");
}

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");
}

Trait Implementations

impl Clone for Metadata [src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Debug for Metadata
1.15.0
[src]

Formats the value using the given formatter.

impl MetadataExt for Metadata
1.1.0
[src]

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

impl MetadataExt for Metadata
1.1.0
[src]

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/fs/struct.Metadata.html