symlink_file in std::os::windows::fs - Rust (original) (raw)

Function symlink_file

1.1.0 · Source

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

Available on Windows only.

Expand description

Creates a new symlink to a non-directory file on the filesystem.

The link path will be a file symbolic link pointing to the originalpath.

The original path should not be a directory or a symlink to a directory, otherwise the symlink will be broken. Use symlink_dir for directories.

This function currently corresponds to CreateSymbolicLinkW. Note that this may change in the future.

§Examples

use std::os::windows::fs;

fn main() -> std::io::Result<()> {
    fs::symlink_file("a.txt", "b.txt")?;
    Ok(())
}

§Limitations

Windows treats symlink creation as a privileged action, therefore this function is likely to fail unless the user makes changes to their system to permit symlink creation. Users can try enabling Developer Mode, granting the SeCreateSymbolicLinkPrivilege privilege, or running the process as an administrator.