Function file_system::hard_link1.0.0[][src]

pub fn hard_link<P, Q>(original: P, link: Q) -> Result<(), Error> where
    P: AsRef<Path>,
    Q: AsRef<Path>, 

Creates a new hard link on the filesystem.

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

If original names a symbolic link, it is platform-specific whether the symbolic link is followed. On platforms where it’s possible to not follow it, it is not followed, and the created hard link points to the symbolic link itself.

Platform-specific behavior

This function currently corresponds to the linkat function with no flags 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:

Examples

use std::fs;

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