impl Metadata

fn file_type(self: &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(())
}

fn is_dir(self: &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(())
}

fn is_file(self: &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(())
}

fn is_symlink(self: &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(())
}

fn len(self: &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(())
}

fn permissions(self: &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(())
}

fn modified(self: &Self) -> io::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(())
}

fn accessed(self: &Self) -> io::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(())
}

fn created(self: &Self) -> io::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(())
}

impl Clone for Metadata

fn clone(self: &Self) -> Metadata

impl Debug for Metadata

fn fmt(self: &Self, f: &mut fmt::Formatter<'_>) -> fmt::Result

impl Freeze for Metadata

impl MetadataExt for crate::fs::Metadata

fn as_raw_stat(self: &Self) -> &super::raw::stat

fn st_dev(self: &Self) -> u64

fn st_ino(self: &Self) -> u64

fn st_mode(self: &Self) -> u32

fn st_nlink(self: &Self) -> u64

fn st_uid(self: &Self) -> u32

fn st_gid(self: &Self) -> u32

fn st_rdev(self: &Self) -> u64

fn st_size(self: &Self) -> u64

fn st_atime(self: &Self) -> i64

fn st_atime_nsec(self: &Self) -> i64

fn st_mtime(self: &Self) -> i64

fn st_mtime_nsec(self: &Self) -> i64

fn st_ctime(self: &Self) -> i64

fn st_ctime_nsec(self: &Self) -> i64

fn st_birthtime(self: &Self) -> i64

fn st_birthtime_nsec(self: &Self) -> i64

fn st_blksize(self: &Self) -> u64

fn st_blocks(self: &Self) -> u64

fn st_gen(self: &Self) -> u32

fn st_flags(self: &Self) -> u32

fn st_lspare(self: &Self) -> u32

impl MetadataExt for crate::fs::Metadata

fn file_attributes(self: &Self) -> u32

fn creation_time(self: &Self) -> u64

fn last_access_time(self: &Self) -> u64

fn last_write_time(self: &Self) -> u64

fn file_size(self: &Self) -> u64

fn volume_serial_number(self: &Self) -> Option<u32>

fn number_of_links(self: &Self) -> Option<u32>

fn file_index(self: &Self) -> Option<u64>

fn change_time(self: &Self) -> Option<u64>

impl MetadataExt for crate::fs::Metadata

fn as_raw_stat(self: &Self) -> &raw::stat

fn st_dev(self: &Self) -> u64

fn st_ino(self: &Self) -> u64

fn st_mode(self: &Self) -> u32

fn st_nlink(self: &Self) -> u64

fn st_uid(self: &Self) -> u32

fn st_gid(self: &Self) -> u32

fn st_rdev(self: &Self) -> u64

fn st_size(self: &Self) -> u64

fn st_atime(self: &Self) -> i64

fn st_atime_nsec(self: &Self) -> i64

fn st_mtime(self: &Self) -> i64

fn st_mtime_nsec(self: &Self) -> i64

fn st_ctime(self: &Self) -> i64

fn st_ctime_nsec(self: &Self) -> i64

fn st_blksize(self: &Self) -> u64

fn st_blocks(self: &Self) -> u64

impl MetadataExt for fs::Metadata

fn dev(self: &Self) -> u64

fn ino(self: &Self) -> u64

fn nlink(self: &Self) -> u64

impl MetadataExt for fs::Metadata

fn dev(self: &Self) -> u64

fn ino(self: &Self) -> u64

fn mode(self: &Self) -> u32

fn nlink(self: &Self) -> u64

fn uid(self: &Self) -> u32

fn gid(self: &Self) -> u32

fn rdev(self: &Self) -> u64

fn size(self: &Self) -> u64

fn atime(self: &Self) -> i64

fn atime_nsec(self: &Self) -> i64

fn mtime(self: &Self) -> i64

fn mtime_nsec(self: &Self) -> i64

fn ctime(self: &Self) -> i64

fn ctime_nsec(self: &Self) -> i64

fn blksize(self: &Self) -> u64

fn blocks(self: &Self) -> u64

impl RefUnwindSafe for Metadata

impl Send for Metadata

impl Sync for Metadata

impl Unpin for Metadata

impl UnwindSafe for Metadata

impl<T> Any for Metadata

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for Metadata

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for Metadata

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> CloneToUninit for Metadata

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

impl<T> From for Metadata

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for Metadata

fn to_owned(self: &Self) -> T

fn clone_into(self: &Self, target: &mut T)

impl<T, U> Into for Metadata

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for Metadata

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for Metadata

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>