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.
Returns the file type for this metadata.
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
println!("{:?}", metadata.file_type());
Ok(())
}Run
Returns whether this metadata is for a directory. The
result is mutually exclusive to the result of
is_file
, and will be false for symlink metadata
obtained from symlink_metadata
.
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
assert!(!metadata.is_dir());
Ok(())
}Run
Returns whether this metadata is for a regular file. The
result is mutually exclusive to the result of
is_dir
, and will be false for symlink metadata
obtained from symlink_metadata
.
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert!(metadata.is_file());
Ok(())
}Run
Returns the size of the file, in bytes, this metadata is for.
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert_eq!(0, metadata.len());
Ok(())
}Run
Returns the permissions of the file this metadata is for.
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert!(!metadata.permissions().readonly());
Ok(())
}Run
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.
This field may not be available on all platforms, and will return an
Err
on platforms where it is not available.
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(())
}Run
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
.
This field may not be available on all platforms, and will return an
Err
on platforms where it is not available.
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(())
}Run
Returns the creation time listed in this metadata.
The returned value corresponds to the birthtime
field of stat
on
Unix platforms and the ftCreationTime
field on Windows platforms.
This field may not be available on all platforms, and will return an
Err
on platforms where it is not available.
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");
}
Ok(())
}Run
Deprecated since 1.8.0
: deprecated in favor of the accessor methods of this trait
This is supported on Linux only.
Gain a reference to the underlying stat
structure which contains the raw information returned by the OS. Read more
This is supported on Linux only.
Returns the device ID on which this file resides. Read more
This is supported on Linux only.
This is supported on Linux only.
This is supported on Linux only.
Returns the number of hard links to file. Read more
This is supported on Linux only.
Returns the user ID of the file owner. Read more
This is supported on Linux only.
Returns the group ID of the file owner. Read more
This is supported on Linux only.
Returns the device ID that this file represents. Only relevant for special file. Read more
This is supported on Linux only.
Returns the size of the file (if it is a regular file or a symbolic link) in bytes. Read more
This is supported on Linux only.
Returns the last access time of the file, in seconds since Unix Epoch. Read more
This is supported on Linux only.
Returns the last access time of the file, in nanoseconds since [st_atime
]. Read more
This is supported on Linux only.
Returns the last modification time of the file, in seconds since Unix Epoch. Read more
This is supported on Linux only.
Returns the last modification time of the file, in nanoseconds since [st_mtime
]. Read more
This is supported on Linux only.
Returns the last status change time of the file, in seconds since Unix Epoch. Read more
This is supported on Linux only.
Returns the last status change time of the file, in nanoseconds since [st_ctime
]. Read more
This is supported on Linux only.
Returns the "preferred" blocksize for efficient filesystem I/O. Read more
This is supported on Linux only.
Returns the number of blocks allocated to the file, 512-byte units. Read more
This is supported on Unix only.
Returns the ID of the device containing the file. Read more
This is supported on Unix only.
This is supported on Unix only.
Returns the rights applied to this file. Read more
This is supported on Unix only.
Returns the number of hard links pointing to this file. Read more
This is supported on Unix only.
Returns the user ID of the owner of this file. Read more
This is supported on Unix only.
Returns the group ID of the owner of this file. Read more
This is supported on Unix only.
Returns the device ID of this file (if it is a special one). Read more
This is supported on Unix only.
Returns the total size of this file in bytes. Read more
This is supported on Unix only.
Returns the last access time of the file, in seconds since Unix Epoch. Read more
This is supported on Unix only.
Returns the last access time of the file, in nanoseconds since [atime
]. Read more
This is supported on Unix only.
Returns the last modification time of the file, in seconds since Unix Epoch. Read more
This is supported on Unix only.
Returns the last modification time of the file, in nanoseconds since [mtime
]. Read more
This is supported on Unix only.
Returns the last status change time of the file, in seconds since Unix Epoch. Read more
This is supported on Unix only.
Returns the last status change time of the file, in nanoseconds since [ctime
]. Read more
This is supported on Unix only.
Returns the blocksize for filesystem I/O. Read more
This is supported on Unix only.
Returns the number of blocks allocated to the file, in 512-byte units. Read more
This is supported on Windows only.
Returns the value of the dwFileAttributes
field of this metadata. Read more
This is supported on Windows only.
Returns the value of the ftCreationTime
field of this metadata. Read more
This is supported on Windows only.
Returns the value of the ftLastAccessTime
field of this metadata. Read more
This is supported on Windows only.
Returns the value of the ftLastWriteTime
field of this metadata. Read more
This is supported on Windows only.
Returns the value of the nFileSize{High,Low}
fields of this metadata. Read more
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
🔬 This is a nightly-only experimental API. (
try_from
#33417)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (
try_from
#33417)
🔬 This is a nightly-only experimental API. (
try_from
#33417)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (
try_from
#33417)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (get_type_id
#27745)
this method will likely be replaced by an associated static
type Owned = T
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
#41263)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more