std::fs::hard_link - Rust
Description: API documentation for the Rust `hard_link` fn in crate `std`.
Keywords: rust, rustlang, rust-lang, hard_link

# 1.0.0[−][src]Function std::fs::hard_link

    pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> Result<()>

Creates a new hard link on the filesystem.

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.

If `src` 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:

- The `src` path is not a file or doesn't exist.

# Examples

    use std::fs;

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

Run