add typesafe std/paths, std/files, std/dirs, std/symlinks (#20582)
* split std/os; add typesafe std/paths * add more files, dirs, paths * add documentation * add testcase * remove tryRemoveFile * clean up * Delete test.nim * apply changes * add `add` and fixes
This commit is contained in:
parent
66cbcaab84
commit
3c12b72168
6 changed files with 775 additions and 0 deletions
45
lib/std/files.nim
Normal file
45
lib/std/files.nim
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
from paths import Path, ReadDirEffect, WriteDirEffect
|
||||
|
||||
from std/private/osfiles import fileExists, removeFile,
|
||||
moveFile
|
||||
|
||||
|
||||
proc fileExists*(filename: Path): bool {.inline, tags: [ReadDirEffect].} =
|
||||
## Returns true if `filename` exists and is a regular file or symlink.
|
||||
##
|
||||
## Directories, device files, named pipes and sockets return false.
|
||||
result = fileExists(filename.string)
|
||||
|
||||
proc removeFile*(file: Path) {.inline, tags: [WriteDirEffect].} =
|
||||
## Removes the `file`.
|
||||
##
|
||||
## If this fails, `OSError` is raised. This does not fail
|
||||
## if the file never existed in the first place.
|
||||
##
|
||||
## On Windows, ignores the read-only attribute.
|
||||
##
|
||||
## See also:
|
||||
## * `removeDir proc`_
|
||||
## * `copyFile proc`_
|
||||
## * `copyFileWithPermissions proc`_
|
||||
## * `moveFile proc`_
|
||||
removeFile(file.string)
|
||||
|
||||
proc moveFile*(source, dest: Path) {.inline,
|
||||
tags: [ReadDirEffect, ReadIOEffect, WriteIOEffect].} =
|
||||
## Moves a file from `source` to `dest`.
|
||||
##
|
||||
## Symlinks are not followed: if `source` is a symlink, it is itself moved,
|
||||
## not its target.
|
||||
##
|
||||
## If this fails, `OSError` is raised.
|
||||
## If `dest` already exists, it will be overwritten.
|
||||
##
|
||||
## Can be used to `rename files`:idx:.
|
||||
##
|
||||
## See also:
|
||||
## * `moveDir proc`_
|
||||
## * `copyFile proc`_
|
||||
## * `copyFileWithPermissions proc`_
|
||||
## * `removeFile proc`_
|
||||
moveFile(source.string, dest.string)
|
||||
Loading…
Add table
Add a link
Reference in a new issue