dirs

nimony/lib/std/dirs.nim

• proc tryCreateFinalDir(dir: Path): ErrorCode

  Tries to create the final directory in a path. In other words, it tries to create a single new directory, not a nested one. It returns the OS's error code making it easy to distinguish between "could not create" and "already exists".

• proc createDir(dir: Path)

  Creates a new directory dir. If the directory already exists, no error is raised. This can be used to create a nested directory structure directly.

• proc tryRemoveFinalDir(dir: Path): ErrorCode

  Tries to remove the final directory in a path. In other words, it tries to remove a single directory, not a nested one. It returns the OS's error code making it easy to distinguish between "could not remove" and "does not exist".

• proc removeDir(dir: Path)

  Removes the directory dir. If the directory does not exist, no error is raised.

• proc tryRemoveFile(file: Path): ErrorCode
• proc removeFile(file: Path)

  Removes the file file. If the file does not exist, no error is raised.

• type DirEntry = object
    kind: PathComponent
    path: Path

• type DirWalker = object
    pimpl: ptr DIR
    dir: Path
    status: ErrorCode

• proc tryOpenDir(dir: sink Path): DirWalker

  Tries to open the directory dir for iteration over its entries.

• proc tryNextDir(w: var DirWalker; e: var DirEntry): bool
• proc tryCloseDir(w: var DirWalker): ErrorCode
• iterator walkDir(dir: Path; relative: bool; checkDir: bool): tuple[kind: PathComponent, path: Path]

  Walks over all entries in the directory dir.

  Yields tuples of (kind, path) where kind is one of:

  • pcFile - regular file
  • pcDir - directory
  • pcLinkToFile - symbolic link to a file
  • pcLinkToDir - symbolic link to a directory

  If relative is true, yields relative paths (just the filename/dirname), otherwise yields full paths.

  If checkDir is true, raises an error if dir doesn't exist or isn't a directory.

  Special directories "." and ".." are skipped.

• proc getCurrentDir(): Path

  Returns the current working directory as a Path.

  Raises an error if unable to retrieve the current directory.

  See also:

  • setCurrentDir proc_
• proc setCurrentDir(dir: Path)

  Sets the current working directory to dir.

  Raises errors if the directory doesn't exist or lacks permissions.

  See also:

  • getCurrentDir proc_