Struct Metadata

pub struct Metadata { /* private fields */ }

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 size and type.

Implementations

impl Metadata

pub const fn file_type(&self) -> FileType

Returns the file type for this metadata.

Examples

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

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

    println!("{:?}", metadata.file_type());
    Ok(())
}

pub const fn is_dir(&self) -> bool

Tests whether this file type represents a directory. The result is mutually exclusive to the results of is_file; only one of these tests may pass.

Examples

use vexide::fs;

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

assert!(!metadata.is_dir());

pub const fn is_file(&self) -> bool

Tests whether this file type represents a regular file. The result is mutually exclusive to the results of is_dir; only one of these tests may pass.

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. See File::open or OpenOptions::open for more information.

Examples

use vexide::fs;

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

assert!(metadata.is_file());

pub fn len(&self) -> Option<u64>

Returns the size of the file, in bytes, this metadata is for.

Examples

use vexide::fs;

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

assert_eq!(0, metadata.len());

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.