bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Document when to use Windows' symlink_dir vs. symlink_file

Browse source 
It was previously unclear which should be used when.
This commit is contained in:
Chris Denton 2021-09-04 19:22:34 +01:00
parent 226e181b80
commit 2d95b5bce7
No known key found for this signature in database
GPG key ID: 713472F2F45627DE
1 changed files with 20 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

22
library/std/src/os/windows/fs.rs
View file

@ -517,11 +517,20 @@ impl FileTypeExt for fs::FileType {
}
}
/// Creates a new file symbolic link on the filesystem.
/// Creates a new symlink to a non-directory file on the filesystem.
///
/// The `link` path will be a file symbolic link pointing to the `original`
/// path.
///
/// 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`][CreateSymbolicLinkW].
/// Note that this [may change in the future][changes].
///
/// [CreateSymbolicLinkW]: https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-createsymboliclinkw
/// [changes]: io#platform-specific-behavior
///
/// # Examples
///
/// ```no_run
@ -537,11 +546,20 @@ pub fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(original: P, link: Q) -> io:
sys::fs::symlink_inner(original.as_ref(), link.as_ref(), false)
}
/// Creates a new directory symlink on the filesystem.
/// Creates a new symlink to a directory on the filesystem.
///
/// The `link` path will be a directory symbolic link pointing to the `original`
/// path.
///
/// The `original` path must be a directory or a symlink to a directory,
/// otherwise the symlink will be broken. Use [`symlink_file`] for other files.
///
/// This function currently corresponds to [`CreateSymbolicLinkW`][CreateSymbolicLinkW].
/// Note that this [may change in the future][changes].
///
/// [CreateSymbolicLinkW]: https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-createsymboliclinkw
/// [changes]: io#platform-specific-behavior
///
/// # Examples
///
/// ```no_run