mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-28 17:04:41 +00:00
4d11d0619d
follow up https://github.com/nim-lang/Nim/pull/22851 follow up https://github.com/nim-lang/Nim/pull/22873
34 lines
1.2 KiB
Nim
34 lines
1.2 KiB
Nim
## This module implements symlink (symbolic link) handling.
|
|
|
|
## .. importdoc:: os.nim
|
|
|
|
from std/paths import Path, ReadDirEffect
|
|
|
|
from std/private/ossymlinks import symlinkExists, createSymlink, expandSymlink
|
|
|
|
proc symlinkExists*(link: Path): bool {.inline, tags: [ReadDirEffect], sideEffect.} =
|
|
## Returns true if the symlink `link` exists. Will return true
|
|
## regardless of whether the link points to a directory or file.
|
|
result = symlinkExists(link.string)
|
|
|
|
proc createSymlink*(src, dest: Path) {.inline.} =
|
|
## Create a symbolic link at `dest` which points to the item specified
|
|
## by `src`. On most operating systems, will fail if a link already exists.
|
|
##
|
|
## .. warning:: Some OS's (such as Microsoft Windows) restrict the creation
|
|
## of symlinks to root users (administrators) or users with developer mode enabled.
|
|
##
|
|
## See also:
|
|
## * `createHardlink proc`_
|
|
## * `expandSymlink proc`_
|
|
createSymlink(src.string, dest.string)
|
|
|
|
proc expandSymlink*(symlinkPath: Path): Path {.inline.} =
|
|
## Returns a string representing the path to which the symbolic link points.
|
|
##
|
|
## On Windows this is a noop, `symlinkPath` is simply returned.
|
|
##
|
|
## See also:
|
|
## * `createSymlink proc`_
|
|
result = Path(expandSymlink(symlinkPath.string))
|