Struct std::fs::Metadata

pub struct Metadata(_);

Metadata information about a file.

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

Methods

impl Metadata

fn file_type(&self) -> FileType

Returns the file type for this metadata.

fn is_dir(&self) -> bool

Returns whether this metadata is for a directory.

Examples

fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.is_dir()); Ok(()) } }

use std::fs;

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

assert!(!metadata.is_dir());

fn is_file(&self) -> bool

Returns whether this metadata is for a regular file.

Examples

fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(metadata.is_file()); Ok(()) } }

use std::fs;

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

assert!(metadata.is_file());

fn len(&self) -> u64

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

Examples

fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert_eq!(0, metadata.len()); Ok(()) } }

use std::fs;

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

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

fn permissions(&self) -> Permissions

Returns the permissions of the file this metadata is for.

Examples

fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.permissions().readonly()); Ok(()) } }

use std::fs;

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

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

fn modified(&self) -> Result<SystemTime>

Unstable (fs_time #31399)

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.

fn accessed(&self) -> Result<SystemTime>

Unstable (fs_time #31399)

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.

fn created(&self) -> Result<SystemTime>

Unstable (fs_time #31399)

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.

Trait Implementations

impl MetadataExt for Metadata

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

impl MetadataExt for Metadata

fn as_raw_stat(&self) -> &stat

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

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_blksize(&self) -> u64

fn st_blocks(&self) -> u64

Derived Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.