pub struct Metadata(/* private fields */);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§
source§impl Metadata
impl Metadata
sourcepub fn is_dir(&self) -> bool
pub fn is_dir(&self) -> bool
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(())
}Runsourcepub fn is_file(&self) -> bool
pub fn is_file(&self) -> bool
Returns 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(())
}Run1.58.0 · sourcepub fn is_symlink(&self) -> bool
pub fn is_symlink(&self) -> bool
Returns true if this metadata is for a symbolic link.
Examples
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_exist/", link_path)?;
let metadata = fs::symlink_metadata(link_path)?;
assert!(metadata.is_symlink());
Ok(())
}Runsourcepub fn permissions(&self) -> Permissions
pub fn permissions(&self) -> Permissions
1.10.0 · sourcepub fn modified(&self) -> Result<SystemTime>
pub fn modified(&self) -> Result<SystemTime>
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 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(())
}Run1.10.0 · sourcepub fn accessed(&self) -> Result<SystemTime>
pub fn accessed(&self) -> Result<SystemTime>
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 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(())
}Run1.10.0 · sourcepub fn created(&self) -> Result<SystemTime>
pub fn created(&self) -> Result<SystemTime>
Returns 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§
source§impl MetadataExt for Metadata
Available on WASI only.
impl MetadataExt for Metadata
source§fn dev(&self) -> u64
fn dev(&self) -> u64
wasi_ext #71213)st_dev field of the internal filestat_tsource§fn ino(&self) -> u64
fn ino(&self) -> u64
wasi_ext #71213)st_ino field of the internal filestat_tsource§fn nlink(&self) -> u64
fn nlink(&self) -> u64
wasi_ext #71213)st_nlink field of the internal filestat_tsource§fn size(&self) -> u64
fn size(&self) -> u64
wasi_ext #71213)st_size field of the internal filestat_tsource§fn atim(&self) -> u64
fn atim(&self) -> u64
wasi_ext #71213)st_atim field of the internal filestat_t1.1.0 · source§impl MetadataExt for Metadata
Available on Unix only.
impl MetadataExt for Metadata
source§fn atime(&self) -> i64
fn atime(&self) -> i64
source§fn atime_nsec(&self) -> i64
fn atime_nsec(&self) -> i64
source§fn mtime(&self) -> i64
fn mtime(&self) -> i64
source§fn mtime_nsec(&self) -> i64
fn mtime_nsec(&self) -> i64
source§fn ctime(&self) -> i64
fn ctime(&self) -> i64
source§fn ctime_nsec(&self) -> i64
fn ctime_nsec(&self) -> i64
1.1.0 · source§impl MetadataExt for Metadata
Available on Windows only.
impl MetadataExt for Metadata
source§fn file_attributes(&self) -> u32
fn file_attributes(&self) -> u32
dwFileAttributes field of this metadata. Read moresource§fn creation_time(&self) -> u64
fn creation_time(&self) -> u64
ftCreationTime field of this metadata. Read moresource§fn last_access_time(&self) -> u64
fn last_access_time(&self) -> u64
ftLastAccessTime field of this metadata. Read moresource§fn last_write_time(&self) -> u64
fn last_write_time(&self) -> u64
ftLastWriteTime field of this metadata. Read moresource§fn file_size(&self) -> u64
fn file_size(&self) -> u64
nFileSize{High,Low} fields of this
metadata. Read moresource§fn volume_serial_number(&self) -> Option<u32>
fn volume_serial_number(&self) -> Option<u32>
windows_by_handle #63010)dwVolumeSerialNumber field of this
metadata. Read more1.1.0 · source§impl MetadataExt for Metadata
Available on Linux only.
impl MetadataExt for Metadata
source§fn as_raw_stat(&self) -> &stat
fn as_raw_stat(&self) -> &stat
stat structure which contains
the raw information returned by the OS. Read more