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[src]
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
[src]
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
[src]
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
[src]
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
[src]
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[src]
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[src]
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[src]
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
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
[src]
Performs copy-assignment from source
. Read more
impl Debug for Metadata
1.16.0[src]
impl MetadataExt for Metadata
1.1.0[src]
fn as_raw_stat(&self) -> &stat
[src]
: 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
[src]
Returns the device ID on which this file resides.
fn st_ino(&self) -> u64
[src]
Returns the inode number.
fn st_mode(&self) -> u32
[src]
Returns the file type and mode.
fn st_nlink(&self) -> u64
[src]
Returns the number of hard links to file.
fn st_uid(&self) -> u32
[src]
Returns the user ID of the file owner.
fn st_gid(&self) -> u32
[src]
Returns the group ID of the file owner.
fn st_rdev(&self) -> u64
[src]
Returns the device ID that this file represents. Only relevant for special file.
fn st_size(&self) -> u64
[src]
Returns the size of the file (if it is a regular file or a symbolic link) in bytes. Read more
fn st_atime(&self) -> i64
[src]
Returns the last access time.
fn st_atime_nsec(&self) -> i64
[src]
Returns the last access time, nano seconds part.
fn st_mtime(&self) -> i64
[src]
Returns the last modification time.
fn st_mtime_nsec(&self) -> i64
[src]
Returns the last modification time, nano seconds part.
fn st_ctime(&self) -> i64
[src]
Returns the last status change time.
fn st_ctime_nsec(&self) -> i64
[src]
Returns the last status change time, nano seconds part.
fn st_blksize(&self) -> u64
[src]
Returns the "preferred" blocksize for efficient filesystem I/O.
fn st_blocks(&self) -> u64
[src]
Returns the number of blocks allocated to the file, 512-byte units.
impl MetadataExt for Metadata
1.1.0[src]
fn dev(&self) -> u64
[src]
fn ino(&self) -> u64
[src]
fn mode(&self) -> u32
[src]
fn nlink(&self) -> u64
[src]
fn uid(&self) -> u32
[src]
fn gid(&self) -> u32
[src]
fn rdev(&self) -> u64
[src]
fn size(&self) -> u64
[src]
fn atime(&self) -> i64
[src]
fn atime_nsec(&self) -> i64
[src]
fn mtime(&self) -> i64
[src]
fn mtime_nsec(&self) -> i64
[src]
fn ctime(&self) -> i64
[src]
fn ctime_nsec(&self) -> i64
[src]
fn blksize(&self) -> u64
[src]
fn blocks(&self) -> u64
[src]
impl MetadataExt for Metadata
1.1.0[src]
fn file_attributes(&self) -> u32
[src]
Returns the value of the dwFileAttributes
field of this metadata. Read more
fn creation_time(&self) -> u64
[src]
Returns the value of the ftCreationTime
field of this metadata. Read more
fn last_access_time(&self) -> u64
[src]
Returns the value of the ftLastAccessTime
field of this metadata. Read more
fn last_write_time(&self) -> u64
[src]
Returns the value of the ftLastWriteTime
field of this metadata. Read more
fn file_size(&self) -> u64
[src]
Returns the value of the nFileSize{High,Low}
fields of this metadata. Read more