Struct Metadata

pub struct Metadata(/* private fields */);

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.

Implementations

impl Metadata

pub fn is_dir(&self) -> bool

Returns true if this metadata is for a directory.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("path/to/dir").await?;

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

pub fn is_file(&self) -> bool

Returns true if this metadata is for a regular file.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn is_symlink(&self) -> bool

Returns true if this metadata is for a symbolic link.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn len(&self) -> u64

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

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn modified(&self) -> Result<SystemTime>

Returns the last modification time listed in this metadata.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
   let metadata = fs::metadata("foo.txt").await?;

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

pub fn accessed(&self) -> Result<SystemTime>

Returns the last access time listed in this metadata.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn created(&self) -> Result<SystemTime>

Returns the creation time listed in this metadata.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn permissions(&self) -> Permissions

Returns the permissions of the file this metadata is for.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

pub fn file_type(&self) -> FileType

Returns the file type for this metadata.

Examples

use monoio::fs;

#[monoio::main]
async fn main() -> std::io::Result<()> {
    let metadata = fs::metadata("foo.txt").await?;

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

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.

impl MetadataExt for Metadata

fn nlink(&self) -> u64

longarch64 need the into convert.

fn dev(&self) -> u64

Returns the ID of the device containing the file.

fn ino(&self) -> u64

Returns the inode number.

fn mode(&self) -> u32

Returns the rights applied to this file.

fn uid(&self) -> u32

Returns the user ID of the owner of this file.

fn gid(&self) -> u32

Returns the group ID of the owner of this file.

fn rdev(&self) -> u64

Returns the device ID of this file (if it is a special one).

fn size(&self) -> u64

Returns the total size of this file in bytes.

fn atime(&self) -> i64

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

fn atime_nsec(&self) -> i64

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

fn mtime(&self) -> i64

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

fn mtime_nsec(&self) -> i64

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

fn ctime(&self) -> i64

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

fn ctime_nsec(&self) -> i64

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

fn blksize(&self) -> u64

Returns the block size for filesystem I/O.

fn blocks(&self) -> u64

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