pub struct Metadata(/* private fields */);
Expand description
Metadata information about a file.
This structure is returned from the 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 file_type(&self) -> FileType
pub fn file_type(&self) -> FileType
Returns the file type for this metadata.
§Examples
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
println!("{:?}", metadata.file_type());
Ok(())
}
sourcepub fn len(&self) -> u64
pub fn len(&self) -> u64
Returns the size of the file, in bytes, this metadata is for.
§Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert_eq!(0, metadata.len());
Ok(())
}
sourcepub fn permissions(&self) -> Permissions
pub fn permissions(&self) -> Permissions
Returns the permissions of the file this metadata is for.
§Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::metadata("foo.txt")?;
assert!(!metadata.permissions().readonly());
Ok(())
}
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 may 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(())
}
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 may 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(())
}
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 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;
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(())
}