1.0.0[][src]Struct std::fs::Metadata

pub struct Metadata(_);

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.

Methods

impl Metadata[src]

pub fn file_type(&self) -> FileType1.1.0[src]

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(())
}Run

pub fn is_dir(&self) -> bool[src]

Returns true if 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.

Examples

fn main() -> std::io::Result<()> {
    use std::fs;

    let metadata = fs::metadata("foo.txt")?;

    assert!(!metadata.is_dir());
    Ok(())
}Run

pub fn is_file(&self) -> bool[src]

Returns true if 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.

Examples

use std::fs;

fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt")?;

    assert!(metadata.is_file());
    Ok(())
}Run

pub fn len(&self) -> u64[src]

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(())
}Run

pub fn permissions(&self) -> Permissions[src]

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(())
}Run

pub fn modified(&self) -> Result<SystemTime>1.10.0[src]

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(())
}Run

pub fn accessed(&self) -> Result<SystemTime>1.10.0[src]

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(())
}Run

pub fn created(&self) -> Result<SystemTime>1.10.0[src]

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 may 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(())
}Run

Trait Implementations

impl MetadataExt for Metadata1.1.0[src]

impl MetadataExt for Metadata1.1.0[src]

impl MetadataExt for Metadata1.1.0[src]

impl Debug for Metadata1.16.0[src]

impl Clone for Metadata[src]

Auto Trait Implementations

impl UnwindSafe for Metadata

impl RefUnwindSafe for Metadata

impl Unpin for Metadata

impl Send for Metadata

impl Sync for Metadata

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.