Trait MetadataExt

pub trait MetadataExt {
    // Required methods
    fn as_raw_stat(&self) -> &stat;
    fn st_dev(&self) -> u64;
    fn st_ino(&self) -> u64;
    fn st_mode(&self) -> u32;
    fn st_nlink(&self) -> u64;
    fn st_uid(&self) -> u32;
    fn st_gid(&self) -> u32;
    fn st_rdev(&self) -> u64;
    fn st_size(&self) -> u64;
    fn st_atime(&self) -> i64;
    fn st_atime_nsec(&self) -> i64;
    fn st_mtime(&self) -> i64;
    fn st_mtime_nsec(&self) -> i64;
    fn st_ctime(&self) -> i64;
    fn st_ctime_nsec(&self) -> i64;
    fn st_blksize(&self) -> u64;
    fn st_blocks(&self) -> u64;
}

Available on Linux only.

OS-specific extensions to fs::Metadata.

Required Methods

fn as_raw_stat(&self) -> &stat

👎Deprecated since 1.8.0: other methods of this trait are now preferred

Gain a reference to the underlying stat structure which contains the raw information returned by the OS.

The contents of the returned stat are not consistent across Unix platforms. The os::unix::fs::MetadataExt trait contains the cross-Unix abstractions contained within the raw stat.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    let stat = meta.as_raw_stat();
    Ok(())
}

fn st_dev(&self) -> u64

Returns the device ID on which this file resides.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_dev());
    Ok(())
}

fn st_ino(&self) -> u64

Returns the inode number.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_ino());
    Ok(())
}

fn st_mode(&self) -> u32

Returns the file type and mode.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_mode());
    Ok(())
}

fn st_nlink(&self) -> u64

Returns the number of hard links to file.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_nlink());
    Ok(())
}

fn st_uid(&self) -> u32

Returns the user ID of the file owner.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_uid());
    Ok(())
}

fn st_gid(&self) -> u32

Returns the group ID of the file owner.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_gid());
    Ok(())
}

fn st_rdev(&self) -> u64

Returns the device ID that this file represents. Only relevant for special file.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_rdev());
    Ok(())
}

fn st_size(&self) -> u64

Returns the size of the file (if it is a regular file or a symbolic link) in bytes.

The size of a symbolic link is the length of the pathname it contains, without a terminating null byte.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_size());
    Ok(())
}

fn st_atime(&self) -> i64

Returns the last access time of the file, in seconds since Unix Epoch.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_atime());
    Ok(())
}

fn st_atime_nsec(&self) -> i64

Returns the last access time of the file, in nanoseconds since st_atime.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_atime_nsec());
    Ok(())
}

fn st_mtime(&self) -> i64

Returns the last modification time of the file, in seconds since Unix Epoch.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_mtime());
    Ok(())
}

fn st_mtime_nsec(&self) -> i64

Returns the last modification time of the file, in nanoseconds since st_mtime.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_mtime_nsec());
    Ok(())
}

fn st_ctime(&self) -> i64

Returns the last status change time of the file, in seconds since Unix Epoch.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_ctime());
    Ok(())
}

fn st_ctime_nsec(&self) -> i64

Returns the last status change time of the file, in nanoseconds since st_ctime.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_ctime_nsec());
    Ok(())
}

fn st_blksize(&self) -> u64

Returns the “preferred” block size for efficient filesystem I/O.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_blksize());
    Ok(())
}

fn st_blocks(&self) -> u64

Returns the number of blocks allocated to the file, 512-byte units.

Examples

use std::fs;
use std::io;
use std::os::linux::fs::MetadataExt;

fn main() -> io::Result<()> {
    let meta = fs::metadata("some_file")?;
    println!("{}", meta.st_blocks());
    Ok(())
}

Implementors

impl MetadataExt for Metadata