Struct std::fs::Metadata 1.0.0[−][src]
pub struct Metadata(_);Expand description
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.
Implementations
Returns true if this metadata is for a directory. The
result is mutually exclusive to the result of
Metadata::is_file, and will be false for symlink metadata
obtained from symlink_metadata.
Examples
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
assert!(!metadata.is_dir());
Ok(())
}RunReturns true if this metadata is for a regular file. The
result is mutually exclusive to the result of
Metadata::is_dir, and will be false for symlink metadata
obtained from symlink_metadata.
When the goal is simply to read from (or write to) the source, the most
reliable way to test the source can be read (or written to) is to open
it. Only using is_file can break workflows like diff <( prog_a ) on
a Unix-like system for example. See File::open or
OpenOptions::open for more information.
Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert!(metadata.is_file());
Ok(())
}RunReturns true if this metadata is for a symbolic link.
Examples
#![feature(is_symlink)]
use std::fs;
use std::path::Path;
use std::os::unix::fs::symlink;
fn main() -> std::io::Result<()> {
let link_path = Path::new("link");
symlink("/origin_does_not_exists/", link_path)?;
let metadata = fs::symlink_metadata(link_path)?;
assert!(metadata.is_symlink());
Ok(())
}RunReturns 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 might not be available on all platforms, and will return an
Err on platforms where it is not available.
Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
if let Ok(time) = metadata.modified() {
println!("{:?}", time);
} else {
println!("Not supported on this platform");
}
Ok(())
}RunReturns 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 might not be available on all platforms, and will return an
Err on platforms where it is not available.
Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
if let Ok(time) = metadata.accessed() {
println!("{:?}", time);
} else {
println!("Not supported on this platform");
}
Ok(())
}RunReturns the creation time listed in this metadata.
The returned value corresponds to the btime field of statx on
Linux kernel starting from to 4.11, the birthtime field of stat on other
Unix platforms, and the ftCreationTime field on Windows platforms.
Errors
This field might not be available on all platforms, and will return an
Err on platforms or filesystems where it is not available.
Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
if let Ok(time) = metadata.created() {
println!("{:?}", time);
} else {
println!("Not supported on this platform or filesystem");
}
Ok(())
}RunTrait Implementations
other methods of this trait are now preferred
Gain a reference to the underlying stat structure which contains
the raw information returned by the OS. Read more
Returns the device ID that this file represents. Only relevant for special file. Read more
Returns the size of the file (if it is a regular file or a symbolic link) in bytes. Read more
Returns the last access time of the file, in seconds since Unix Epoch. Read more
Returns the last modification time of the file, in seconds since Unix Epoch. Read more
Returns the last status change time of the file, in seconds since Unix Epoch. Read more
Returns the “preferred” block size for efficient filesystem I/O. Read more
Returns the st_dev field of the internal filestat_t
Returns the st_ino field of the internal filestat_t
Returns the st_nlink field of the internal filestat_t
Returns the st_size field of the internal filestat_t
Returns the st_atim field of the internal filestat_t
Returns the st_mtim field of the internal filestat_t
Returns the value of the dwFileAttributes field of this metadata. Read more
Returns the value of the ftCreationTime field of this metadata. Read more
Returns the value of the ftLastAccessTime field of this metadata. Read more
Returns the value of the ftLastWriteTime field of this metadata. Read more
Returns the value of the nFileSize{High,Low} fields of this
metadata. Read more
Auto Trait Implementations
impl RefUnwindSafe for Metadata
impl UnwindSafe for Metadata
Blanket Implementations
Mutably borrows from an owned value. Read more