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
sourceimpl 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
1.1.0 · sourceimpl MetadataExt for Metadata
Available on Unix only.
impl MetadataExt for Metadata
sourcefn atime(&self) -> i64
fn atime(&self) -> i64
Returns the last access time of the file, in seconds since Unix Epoch. Read more
sourcefn atime_nsec(&self) -> i64
fn atime_nsec(&self) -> i64
sourcefn mtime(&self) -> i64
fn mtime(&self) -> i64
Returns the last modification time of the file, in seconds since Unix Epoch. Read more
sourcefn mtime_nsec(&self) -> i64
fn mtime_nsec(&self) -> i64
sourcefn ctime(&self) -> i64
fn ctime(&self) -> i64
Returns the last status change time of the file, in seconds since Unix Epoch. Read more
sourcefn ctime_nsec(&self) -> i64
fn ctime_nsec(&self) -> i64
1.1.0 · sourceimpl MetadataExt for Metadata
Available on Linux only.
impl MetadataExt for Metadata
sourcefn as_raw_stat(&self) -> &stat
fn as_raw_stat(&self) -> &stat
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
sourcefn st_rdev(&self) -> u64
fn st_rdev(&self) -> u64
Returns the device ID that this file represents. Only relevant for special file. Read more
sourcefn st_size(&self) -> u64
fn st_size(&self) -> u64
Returns the size of the file (if it is a regular file or a symbolic link) in bytes. Read more
sourcefn st_atime(&self) -> i64
fn st_atime(&self) -> i64
Returns the last access time of the file, in seconds since Unix Epoch. Read more
sourcefn st_atime_nsec(&self) -> i64
fn st_atime_nsec(&self) -> i64
sourcefn st_mtime(&self) -> i64
fn st_mtime(&self) -> i64
Returns the last modification time of the file, in seconds since Unix Epoch. Read more
sourcefn st_mtime_nsec(&self) -> i64
fn st_mtime_nsec(&self) -> i64
sourcefn st_ctime(&self) -> i64
fn st_ctime(&self) -> i64
Returns the last status change time of the file, in seconds since Unix Epoch. Read more
sourcefn st_ctime_nsec(&self) -> i64
fn st_ctime_nsec(&self) -> i64
sourcefn st_blksize(&self) -> u64
fn st_blksize(&self) -> u64
Returns the “preferred” block size for efficient filesystem I/O. Read more
sourceimpl MetadataExt for Metadata
Available on WASI only.
impl MetadataExt for Metadata
1.1.0 · sourceimpl MetadataExt for Metadata
Available on Windows only.
impl MetadataExt for Metadata
sourcefn file_attributes(&self) -> u32
fn file_attributes(&self) -> u32
Returns the value of the dwFileAttributes
field of this metadata. Read more
sourcefn creation_time(&self) -> u64
fn creation_time(&self) -> u64
Returns the value of the ftCreationTime
field of this metadata. Read more
sourcefn last_access_time(&self) -> u64
fn last_access_time(&self) -> u64
Returns the value of the ftLastAccessTime
field of this metadata. Read more
sourcefn last_write_time(&self) -> u64
fn last_write_time(&self) -> u64
Returns the value of the ftLastWriteTime
field of this metadata. Read more
sourcefn file_size(&self) -> u64
fn file_size(&self) -> u64
Returns the value of the nFileSize{High,Low}
fields of this
metadata. Read more
sourcefn volume_serial_number(&self) -> Option<u32>
fn volume_serial_number(&self) -> Option<u32>
Returns the value of the dwVolumeSerialNumber
field of this
metadata. Read more
sourcefn number_of_links(&self) -> Option<u32>
fn number_of_links(&self) -> Option<u32>
Returns the value of the nNumberOfLinks
field of this
metadata. Read more
Auto Trait Implementations
impl RefUnwindSafe for Metadata
impl Send for Metadata
impl Sync for Metadata
impl Unpin for Metadata
impl UnwindSafe for Metadata
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more