Function tokio::fs::metadata

source ·
pub async fn metadata(path: impl AsRef<Path>) -> Result<Metadata>
Available on crate feature fs only.
Expand description

Given a path, queries the file system to get information about a file, directory, etc.

This is an async version of std::fs::metadata

This function will traverse symbolic links to query information about the destination file.

Platform-specific behavior

This function currently corresponds to the stat function on Unix and the GetFileAttributesEx function on Windows. Note that, this may change in the future.

Errors

This function will return an error in the following situations, but is not limited to just these cases:

  • The user lacks permissions to perform metadata call on path.
  • path does not exist.

Examples

use tokio::fs;

#[tokio::main]
async fn main() -> std::io::Result<()> {
    let attr = fs::metadata("/some/file/path.txt").await?;
    // inspect attr ...
    Ok(())
}