1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use crate::io;
use crate::path::Path;
use crate::task::spawn_blocking;
use crate::utils::Context as _;

/// Creates a hard link on the filesystem.

///

/// The `dst` path will be a link pointing to the `src` path. Note that operating systems often

/// require these two paths to be located on the same filesystem.

///

/// This function is an async version of [`std::fs::hard_link`].

///

/// [`std::fs::hard_link`]: https://doc.rust-lang.org/std/fs/fn.hard_link.html

///

/// # Errors

///

/// An error will be returned in the following situations:

///

/// * `src` does not point to an existing file.

/// * Some other I/O error occurred.

///

/// # Examples

///

/// ```no_run

/// # fn main() -> std::io::Result<()> { async_std::task::block_on(async {

/// #

/// use async_std::fs;

///

/// fs::hard_link("a.txt", "b.txt").await?;

/// #

/// # Ok(()) }) }

/// ```

pub async fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
    let from = from.as_ref().to_owned();
    let to = to.as_ref().to_owned();
    spawn_blocking(move || {
        std::fs::hard_link(&from, &to).context(|| {
            format!(
                "could not create a hard link from `{}` to `{}`",
                from.display(),
                to.display()
            )
        })
    })
    .await
}