tokio::fs

Function hard_link

Source
pub async fn hard_link(
    src: impl AsRef<Path>,
    dst: impl AsRef<Path>,
) -> Result<()>
Expand description

Creates a new hard link on the filesystem.

This is an async version of std::fs::hard_link.

The dst path will be a link pointing to the src path. Note that systems often require these two paths to both be located on the same filesystem.

§Platform-specific behavior

This function currently corresponds to the link function on Unix and the CreateHardLink 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 src path is not a file or doesn’t exist.

§Examples

use tokio::fs;

#[tokio::main]
async fn main() -> std::io::Result<()> {
    fs::hard_link("a.txt", "b.txt").await?; // Hard link a.txt to b.txt
    Ok(())
}