path-io-1.2.2: Interface to ‘directory’ package for users of ‘path’

Copyright | © 2016–2017 Mark Karpov
License | BSD 3 clause
Maintainer | Mark Karpov <markkarpov@openmailbox.org>
Stability | experimental
Portability | portable
Safe Haskell | None
Language | Haskell2010

Path.IO

Contents

- Actions on directories
  - Walking directory trees
  - Current working directory
- Pre-defined directories
- Path transformation
- Actions on files
- Temporary files and directories
- Existence tests
- Permissions
- Timestamps

Description

This module provides interface to System.Directory for users of Path module. It also implements commonly used primitives like recursive scanning and copying of directories.

Synopsis

- createDir :: MonadIO m => Path b Dir -> m ()
- createDirIfMissing :: MonadIO m => Bool -> Path b Dir -> m ()
- ensureDir :: MonadIO m => Path b Dir -> m ()
- removeDir :: MonadIO m => Path b Dir -> m ()
- removeDirRecur :: MonadIO m => Path b Dir -> m ()
- renameDir :: MonadIO m => Path b0 Dir -> Path b1 Dir -> m ()
- listDir :: (MonadIO m, MonadThrow m) => Path b Dir -> m ([Path Abs Dir], [Path Abs File])
- listDirRecur :: (MonadIO m, MonadThrow m) => Path b Dir -> m ([Path Abs Dir], [Path Abs File])
- copyDirRecur :: (MonadIO m, MonadCatch m) => Path b0 Dir -> Path b1 Dir -> m ()
- copyDirRecur' :: (MonadIO m, MonadCatch m) => Path b0 Dir -> Path b1 Dir -> m ()
- data WalkAction
  - = WalkFinish
  - | WalkExclude [Path Abs Dir]
- walkDir :: (MonadIO m, MonadThrow m) => (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m WalkAction) -> Path b Dir -> m ()
- walkDirAccum :: (MonadIO m, MonadThrow m, Monoid o) => Maybe (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m WalkAction) -> (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m o) -> Path b Dir -> m o
- getCurrentDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir)
- setCurrentDir :: MonadIO m => Path b Dir -> m ()
- withCurrentDir :: (MonadIO m, MonadMask m) => Path b Dir -> m a -> m a
- getHomeDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir)
- getAppUserDataDir :: (MonadIO m, MonadThrow m) => String -> m (Path Abs Dir)
- getUserDocsDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir)
- getTempDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir)
- data XdgDirectory :: *
  - = XdgData
  - | XdgConfig
  - | XdgCache
- getXdgDir :: (MonadIO m, MonadThrow m) => XdgDirectory -> Maybe (Path Rel Dir) -> m (Path Abs Dir)
- type family AbsPath path where ...
- type family RelPath path where ...
- class AnyPath path where
- resolveFile :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs File)
- resolveFile' :: (MonadIO m, MonadThrow m) => FilePath -> m (Path Abs File)
- resolveDir :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs Dir)
- resolveDir' :: (MonadIO m, MonadThrow m) => FilePath -> m (Path Abs Dir)
- removeFile :: MonadIO m => Path b File -> m ()
- renameFile :: MonadIO m => Path b0 File -> Path b1 File -> m ()
- copyFile :: MonadIO m => Path b0 File -> Path b1 File -> m ()
- findExecutable :: MonadIO m => Path Rel File -> m (Maybe (Path Abs File))
- findFile :: (MonadIO m, MonadThrow m) => [Path b Dir] -> Path Rel File -> m (Maybe (Path Abs File))
- findFiles :: (MonadIO m, MonadThrow m) => [Path b Dir] -> Path Rel File -> m [Path Abs File]
- findFilesWith :: (MonadIO m, MonadThrow m) => (Path Abs File -> m Bool) -> [Path b Dir] -> Path Rel File -> m [Path Abs File]
- withTempFile :: (MonadIO m, MonadMask m) => Path b Dir -> String -> (Path Abs File -> Handle -> m a) -> m a
- withTempDir :: (MonadIO m, MonadMask m) => Path b Dir -> String -> (Path Abs Dir -> m a) -> m a
- withSystemTempFile :: (MonadIO m, MonadMask m) => String -> (Path Abs File -> Handle -> m a) -> m a
- withSystemTempDir :: (MonadIO m, MonadMask m) => String -> (Path Abs Dir -> m a) -> m a
- openTempFile :: (MonadIO m, MonadThrow m) => Path b Dir -> String -> m (Path Abs File, Handle)
- openBinaryTempFile :: (MonadIO m, MonadThrow m) => Path b Dir -> String -> m (Path Abs File, Handle)
- createTempDir :: (MonadIO m, MonadThrow m) => Path b Dir -> String -> m (Path Abs Dir)
- doesFileExist :: MonadIO m => Path b File -> m Bool
- doesDirExist :: MonadIO m => Path b Dir -> m Bool
- isLocationOccupied :: MonadIO m => Path b t -> m Bool
- forgivingAbsence :: (MonadIO m, MonadCatch m) => m a -> m (Maybe a)
- ignoringAbsence :: (MonadIO m, MonadCatch m) => m a -> m ()
- data Permissions :: *
- emptyPermissions :: Permissions
- readable :: Permissions -> Bool
- writable :: Permissions -> Bool
- executable :: Permissions -> Bool
- searchable :: Permissions -> Bool
- setOwnerReadable :: Bool -> Permissions -> Permissions
- setOwnerWritable :: Bool -> Permissions -> Permissions
- setOwnerExecutable :: Bool -> Permissions -> Permissions
- setOwnerSearchable :: Bool -> Permissions -> Permissions
- getPermissions :: MonadIO m => Path b t -> m Permissions
- setPermissions :: MonadIO m => Path b t -> Permissions -> m ()
- copyPermissions :: MonadIO m => Path b0 t0 -> Path b1 t1 -> m ()
- getAccessTime :: MonadIO m => Path b t -> m UTCTime
- setAccessTime :: MonadIO m => Path b t -> UTCTime -> m ()
- setModificationTime :: MonadIO m => Path b t -> UTCTime -> m ()
- getModificationTime :: MonadIO m => Path b t -> m UTCTime

# Actions on directories

createDir :: MonadIO m => Path b Dir -> m () #

``createDir` dir` creates a new directory `dir` which is initially empty, or as near to empty as the operating system allows.

The operation may fail with:

- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EROFS, EACCES]`
- `isAlreadyExistsError` / `AlreadyExists` The operand refers to a directory that already exists. `[EEXIST]`
- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` The operand is not a valid directory name. `[ENAMETOOLONG, ELOOP]`
- `NoSuchThing` There is no path to the directory. `[ENOENT, ENOTDIR]`
- `ResourceExhausted` Insufficient resources (virtual memory, process file descriptors, physical disk space, etc.) are available to perform the operation. `[EDQUOT, ENOSPC, ENOMEM, EMLINK]`
- `InappropriateType` The path refers to an existing non-directory object. `[EEXIST]`

createDirIfMissing #

Arguments

:: MonadIO m |
=> Bool | Create its parents too?
-> Path b Dir | The path to the directory you want to make
-> m () |

``createDirIfMissing` parents dir` creates a new directory `dir` if it doesn't exist. If the first argument is `True` the function will also create all parent directories if they are missing.

ensureDir :: MonadIO m => Path b Dir -> m () #

Ensure that directory exists creating it and its parent directories if necessary. This is just a handy shortcut:

    ensureDir = createDirIfMissing True

Since: 0.3.1

removeDir :: MonadIO m => Path b Dir -> m () #

``removeDir` dir` removes an existing directory `dir`. The implementation may specify additional constraints which must be satisfied before a directory can be removed (e.g. the directory has to be empty, or may not be in use by other processes). It is not legal for an implementation to partially remove a directory unless the entire directory is removed. A conformant implementation need not support directory removal in all situations (e.g. removal of the root directory).

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` The operand is not a valid directory name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` / `NoSuchThing` The directory does not exist. `[ENOENT, ENOTDIR]`
- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EROFS, EACCES, EPERM]`
- `UnsatisfiedConstraints` Implementation-dependent constraints are not satisfied. `[EBUSY, ENOTEMPTY, EEXIST]`
- `UnsupportedOperation` The implementation does not support removal in this situation. `[EINVAL]`
- `InappropriateType` The operand refers to an existing non-directory object. `[ENOTDIR]`

removeDirRecur :: MonadIO m => Path b Dir -> m () #

``removeDirRecur` dir` removes an existing directory `dir` together with its contents and subdirectories. Within this directory, symbolic links are removed without affecting their targets.

renameDir #

Arguments

:: MonadIO m |
=> Path b0 Dir | Old name
-> Path b1 Dir | New name
-> m () |

``renameDir` old new` changes the name of an existing directory from `old` to `new`. If the `new` directory already exists, it is atomically replaced by the `old` directory. If the `new` directory is neither the `old` directory nor an alias of the `old` directory, it is removed as if by `removeDir`. A conformant implementation need not support renaming directories in all situations (e.g. renaming to an existing directory, or across different physical devices), but the constraints must be documented.

On Win32 platforms, `renameDir` fails if the `new` directory already exists.

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` Either operand is not a valid directory name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` / `NoSuchThing` The original directory does not exist, or there is no path to the target. `[ENOENT, ENOTDIR]`
- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EROFS, EACCES, EPERM]`
- `ResourceExhausted` Insufficient resources are available to perform the operation. `[EDQUOT, ENOSPC, ENOMEM, EMLINK]`
- `UnsatisfiedConstraints` Implementation-dependent constraints are not satisfied. `[EBUSY, ENOTEMPTY, EEXIST]`
- `UnsupportedOperation` The implementation does not support renaming in this situation. `[EINVAL, EXDEV]`
- `InappropriateType` Either path refers to an existing non-directory object. `[ENOTDIR, EISDIR]`

listDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path b Dir | Directory to list
-> m ([Path Abs Dir], [Path Abs File]) | Sub-directories and files

``listDir` dir` returns a list of all entries in `dir` without the special entries (`.` and `..`). Entries are not sorted.

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` The operand is not a valid directory name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` / `NoSuchThing` The directory does not exist. `[ENOENT, ENOTDIR]`
- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EACCES]`
- `ResourceExhausted` Insufficient resources are available to perform the operation. `[EMFILE, ENFILE]`
- `InappropriateType` The path refers to an existing non-directory object. `[ENOTDIR]`

listDirRecur #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path b Dir | Directory to list
-> m ([Path Abs Dir], [Path Abs File]) | Sub-directories and files

Similar to `listDir`, but recursively traverses every sub-directory, and collects all files and directories. This can fail with the same exceptions as `listDir`.

copyDirRecur #

Arguments

:: (MonadIO m, MonadCatch m) |
=> Path b0 Dir | Source
-> Path b1 Dir | Destination
-> m () |

Copy directory recursively. This is not smart about symbolic links, but tries to preserve permissions when possible. If destination directory already exists, new files and sub-directories will complement its structure, possibly overwriting old files if they happen to have the same name as the new ones.

copyDirRecur' #

Arguments

:: (MonadIO m, MonadCatch m) |
=> Path b0 Dir | Source
-> Path b1 Dir | Destination
-> m () |

The same as `copyDirRecur`, but it does not preserve directory permissions. This may be useful, for example, if directory you want to copy is “read-only”, but you want your copy to be editable.

Since: 1.1.0

## Walking directory trees

data WalkAction #

Action returned by the traversal handler function. The action decides how the traversal will proceed further.

Since: 1.2.0

Constructors

WalkFinish | Finish the entire walk altogether
WalkExclude [Path Abs Dir] | List of sub-directories to exclude from descending

walkDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m WalkAction) | Handler (`dir -> subdirs -> files -> `WalkAction``)
-> Path b Dir | Directory where traversal begins
-> m () |

Traverse a directory tree using depth first pre-order traversal, calling a handler function at each directory node traversed. The absolute paths of the parent directory, sub-directories and the files in the directory are provided as arguments to the handler.

Detects and silently avoids any traversal loops in the directory tree.

Since: 1.2.0

walkDirAccum #

Arguments

:: (MonadIO m, MonadThrow m, Monoid o) |
=> Maybe (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m WalkAction) | Descend handler (`dir -> subdirs -> files -> `WalkAction``), descend the whole tree if omitted
-> (Path Abs Dir -> [Path Abs Dir] -> [Path Abs File] -> m o) | Output writer (`dir -> subdirs -> files -> o`)
-> Path b Dir | Directory where traversal begins
-> m o | Accumulation of outputs generated by the output writer invocations

Similar to `walkDir` but accepts a `Monoid` returning, output writer as well. Values returned by the output writer invocations are accumulated and returned.

Both, the descend handler as well as the output writer can be used for side effects but keep in mind that the output writer runs before the descend handler.

Since: 1.2.0

## Current working directory

getCurrentDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir) #

Obtain the current working directory as an absolute path.

In a multithreaded program, the current working directory is a global state shared among all threads of the process. Therefore, when performing filesystem operations from multiple threads, it is highly recommended to use absolute rather than relative paths (see: `makeAbsolute`).

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `isDoesNotExistError` or `NoSuchThing` There is no path referring to the working directory. `[EPERM, ENOENT, ESTALE...]`
- `isPermissionError` or `PermissionDenied` The process has insufficient privileges to perform the operation. `[EACCES]`
- `ResourceExhausted` Insufficient resources are available to perform the operation.
- `UnsupportedOperation` The operating system has no notion of current working directory.

setCurrentDir :: MonadIO m => Path b Dir -> m () #

Change the working directory to the given path.

In a multithreaded program, the current working directory is a global state shared among all threads of the process. Therefore, when performing filesystem operations from multiple threads, it is highly recommended to use absolute rather than relative paths (see: `makeAbsolute`).

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` The operand is not a valid directory name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` or `NoSuchThing` The directory does not exist. `[ENOENT, ENOTDIR]`
- `isPermissionError` or `PermissionDenied` The process has insufficient privileges to perform the operation. `[EACCES]`
- `UnsupportedOperation` The operating system has no notion of current working directory, or the working directory cannot be dynamically changed.
- `InappropriateType` The path refers to an existing non-directory object. `[ENOTDIR]`

withCurrentDir #

Arguments

:: (MonadIO m, MonadMask m) |
=> Path b Dir | Directory to execute in
-> m a | Action to be executed
-> m a |

Run an `IO` action with the given working directory and restore the original working directory afterwards, even if the given action fails due to an exception.

The operation may fail with the same exceptions as `getCurrentDir` and `setCurrentDir`.

# Pre-defined directories

getHomeDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir) #

Returns the current user's home directory.

The directory returned is expected to be writable by the current user, but note that it isn't generally considered good practice to store application-specific data here; use `getAppUserDataDir` instead.

On Unix, `getHomeDir` returns the value of the `HOME` environment variable. On Windows, the system is queried for a suitable path; a typical path might be `C:/Users/<user>`.

The operation may fail with:

- `UnsupportedOperation` The operating system has no notion of home directory.
- `isDoesNotExistError` The home directory for the current user does not exist, or cannot be found.

getAppUserDataDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> String | Name of application (used in path construction)
-> m (Path Abs Dir) |

Obtain the path to a special directory for storing user-specific application data (traditional Unix location).

The argument is usually the name of the application. Since it will be integrated into the path, it must consist of valid path characters.

- On Unix-like systems, the path is `~/.<app>`.
- On Windows, the path is `%APPDATA%/<app>` (e.g. `C:/Users/<user>/AppData/Roaming/<app>`)

Note: the directory may not actually exist, in which case you would need to create it. It is expected that the parent directory exists and is writable.

The operation may fail with:

- `UnsupportedOperation` The operating system has no notion of application-specific data directory.
- `isDoesNotExistError` The home directory for the current user does not exist, or cannot be found.

getUserDocsDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir) #

Returns the current user's document directory.

The directory returned is expected to be writable by the current user, but note that it isn't generally considered good practice to store application-specific data here; use `getAppUserDataDir` instead.

On Unix, `getUserDocsDir` returns the value of the `HOME` environment variable. On Windows, the system is queried for a suitable path; a typical path might be `C:/Users/<user>/Documents`.

The operation may fail with:

- `UnsupportedOperation` The operating system has no notion of document directory.
- `isDoesNotExistError` The document directory for the current user does not exist, or cannot be found.

getTempDir :: (MonadIO m, MonadThrow m) => m (Path Abs Dir) #

Returns the current directory for temporary files.

On Unix, `getTempDir` returns the value of the `TMPDIR` environment variable or "/tmp" if the variable isn't defined. On Windows, the function checks for the existence of environment variables in the following order and uses the first path found:

- TMP environment variable.
- TEMP environment variable.
- USERPROFILE environment variable.
- The Windows directory

The operation may fail with:

- `UnsupportedOperation` The operating system has no notion of temporary directory.

The function doesn't verify whether the path exists.

data XdgDirectory :: * #

Special directories for storing user-specific application data, configuration, and cache files, as specified by the XDG Base Directory Specification.

Note: On Windows, `XdgData` and `XdgConfig` map to the same directory.

Since: 1.2.3.0

Constructors

XdgData | For data files (e.g. images). Defaults to `~/.local/share` and can be overridden by the `XDG_DATA_HOME` environment variable. On Windows, it is `%APPDATA%` (e.g. `C:/Users/<user>/AppData/Roaming`). Can be considered as the user-specific equivalent of `/usr/share`.
XdgConfig | For configuration files. Defaults to `~/.config` and can be overridden by the `XDG_CONFIG_HOME` environment variable. On Windows, it is `%APPDATA%` (e.g. `C:/Users/<user>/AppData/Roaming`). Can be considered as the user-specific equivalent of `/etc`.
XdgCache | For non-essential files (e.g. cache). Defaults to `~/.cache` and can be overridden by the `XDG_CACHE_HOME` environment variable. On Windows, it is `%LOCALAPPDATA%` (e.g. `C:/Users/<user>/AppData/Local`). Can be considered as the user-specific equivalent of `/var/cache`.

Instances

Bounded XdgDirectory |
Methods minBound :: XdgDirectory # maxBound :: XdgDirectory #
Enum XdgDirectory |
Methods succ :: XdgDirectory -> XdgDirectory # pred :: XdgDirectory -> XdgDirectory # toEnum :: Int -> XdgDirectory # fromEnum :: XdgDirectory -> Int # enumFrom :: XdgDirectory -> [XdgDirectory] # enumFromThen :: XdgDirectory -> XdgDirectory -> [XdgDirectory] # enumFromTo :: XdgDirectory -> XdgDirectory -> [XdgDirectory] # enumFromThenTo :: XdgDirectory -> XdgDirectory -> XdgDirectory -> [XdgDirectory] #
Eq XdgDirectory |
Methods (==) :: XdgDirectory -> XdgDirectory -> Bool # (/=) :: XdgDirectory -> XdgDirectory -> Bool #
Ord XdgDirectory |
Methods compare :: XdgDirectory -> XdgDirectory -> Ordering # (<) :: XdgDirectory -> XdgDirectory -> Bool # (<=) :: XdgDirectory -> XdgDirectory -> Bool # (>) :: XdgDirectory -> XdgDirectory -> Bool # (>=) :: XdgDirectory -> XdgDirectory -> Bool # max :: XdgDirectory -> XdgDirectory -> XdgDirectory # min :: XdgDirectory -> XdgDirectory -> XdgDirectory #
Read XdgDirectory |
Methods readsPrec :: Int -> ReadS XdgDirectory # readList :: ReadS [XdgDirectory] # readPrec :: ReadPrec XdgDirectory # readListPrec :: ReadPrec [XdgDirectory] #
Show XdgDirectory |
Methods showsPrec :: Int -> XdgDirectory -> ShowS # show :: XdgDirectory -> String # showList :: [XdgDirectory] -> ShowS #

getXdgDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> XdgDirectory | Which special directory
-> Maybe (Path Rel Dir) | A relative path that is appended to the path; if `Nothing`, the base path is returned
-> m (Path Abs Dir) |

Obtain the paths to special directories for storing user-specific application data, configuration, and cache files, conforming to the XDG Base Directory Specification. Compared with `getAppUserDataDir`, this function provides a more fine-grained hierarchy as well as greater flexibility for the user.

It also works on Windows, although in that case `XdgData` and `XdgConfig` will map to the same directory.

Note: The directory may not actually exist, in which case you would need to create it with file mode `700` (i.e. only accessible by the owner).

Note also: this is a piece of conditional API, only available if `directory-1.2.3.0` or later is used.

Since: 1.2.1

# Path transformation

type family AbsPath path where ... #

Closed type family describing how to get absolute version of given `Path`.

Equations

AbsPath (Path b File) = Path Abs File |
AbsPath (Path b Dir) = Path Abs Dir |

type family RelPath path where ... #

Closed type family describing how to get relative version of given `Path`.

Since: 0.3.0

Equations

RelPath (Path b File) = Path Rel File |
RelPath (Path b Dir) = Path Rel Dir |

class AnyPath path where #

Class of things (`Path`s) that can be canonicalized and made absolute.

Minimal complete definition

canonicalizePath, makeAbsolute, makeRelative, makeRelativeToCurrentDir

Methods

canonicalizePath :: (MonadIO m, MonadThrow m) => path -> m (AbsPath path) #

Make a path absolute and remove as many indirections from it as possible. Indirections include the two special directories `.` and `..`, as well as any symbolic links. The input path need not point to an existing file or directory.

Note: if you require only an absolute path, use `makeAbsolute` instead. Most programs need not care about whether a path contains symbolic links.

Due to the fact that symbolic links and `..` are dependent on the state of the existing filesystem, the function can only make a conservative, best-effort attempt. Nevertheless, if the input path points to an existing file or directory, then the output path shall also point to the same file or directory.

Formally, symbolic links and `..` are removed from the longest prefix of the path that still points to an existing file. The function is not atomic, therefore concurrent changes in the filesystem may lead to incorrect results.

(Despite the name, the function does not guarantee canonicity of the returned path due to the presence of hard links, mount points, etc.)

Similar to `normalise`, an empty path is equivalent to the current directory.

Known bug(s): on Windows, the function does not resolve symbolic links.

Please note that before version 1.2.3.0 of `directory` package, this function had unpredictable behavior on non-existent paths.

makeAbsolute :: (MonadIO m, MonadThrow m) => path -> m (AbsPath path) #

Make a path absolute by prepending the current directory (if it isn't already absolute) and applying `normalise` to the result.

If the path is already absolute, the operation never fails. Otherwise, the operation may fail with the same exceptions as `getCurrentDirectory`.

makeRelative :: MonadThrow m => Path Abs Dir -> path -> m (RelPath path) #

Make a path relative to given directory.

Since: 0.3.0

makeRelativeToCurrentDir :: (MonadIO m, MonadThrow m) => path -> m (RelPath path) #

Make a path relative to current working directory.

Since: 0.3.0

Instances

AnyPath (Path b Dir) # |
Methods canonicalizePath :: (MonadIO m, MonadThrow m) => Path b Dir -> m (AbsPath (Path b Dir)) # makeAbsolute :: (MonadIO m, MonadThrow m) => Path b Dir -> m (AbsPath (Path b Dir)) # makeRelative :: MonadThrow m => Path Abs Dir -> Path b Dir -> m (RelPath (Path b Dir)) # makeRelativeToCurrentDir :: (MonadIO m, MonadThrow m) => Path b Dir -> m (RelPath (Path b Dir)) #
AnyPath (Path b File) # |
Methods canonicalizePath :: (MonadIO m, MonadThrow m) => Path b File -> m (AbsPath (Path b File)) # makeAbsolute :: (MonadIO m, MonadThrow m) => Path b File -> m (AbsPath (Path b File)) # makeRelative :: MonadThrow m => Path Abs Dir -> Path b File -> m (RelPath (Path b File)) # makeRelativeToCurrentDir :: (MonadIO m, MonadThrow m) => Path b File -> m (RelPath (Path b File)) #

resolveFile #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path Abs Dir | Base directory
-> FilePath | Path to resolve
-> m (Path Abs File) |

Append stringly-typed path to an absolute path and then canonicalize it.

Since: 0.3.0

resolveFile' #

Arguments

:: (MonadIO m, MonadThrow m) |
=> FilePath | Path to resolve
-> m (Path Abs File) |

The same as `resolveFile`, but uses current working directory.

Since: 0.3.0

resolveDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path Abs Dir | Base directory
-> FilePath | Path to resolve
-> m (Path Abs Dir) |

The same as `resolveFile`, but for directories.

Since: 0.3.0

resolveDir' #

Arguments

:: (MonadIO m, MonadThrow m) |
=> FilePath | Path to resolve
-> m (Path Abs Dir) |

The same as `resolveDir`, but uses current working directory.

Since: 0.3.0

# Actions on files

removeFile :: MonadIO m => Path b File -> m () #

``removeFile` file` removes the directory entry for an existing file `file`, where `file` is not itself a directory. The implementation may specify additional constraints which must be satisfied before a file can be removed (e.g. the file may not be in use by other processes).

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` The operand is not a valid file name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` / `NoSuchThing` The file does not exist. `[ENOENT, ENOTDIR]`
- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EROFS, EACCES, EPERM]`
- `UnsatisfiedConstraints` Implementation-dependent constraints are not satisfied. `[EBUSY]`
- `InappropriateType` The operand refers to an existing directory. `[EPERM, EINVAL]`

renameFile #

Arguments

:: MonadIO m |
=> Path b0 File | Original location
-> Path b1 File | New location
-> m () |

``renameFile` old new` changes the name of an existing file system object from old to new. If the new object already exists, it is atomically replaced by the old object. Neither path may refer to an existing directory. A conformant implementation need not support renaming files in all situations (e.g. renaming across different physical devices), but the constraints must be documented.

The operation may fail with:

- `HardwareFault` A physical I/O error has occurred. `[EIO]`
- `InvalidArgument` Either operand is not a valid file name. `[ENAMETOOLONG, ELOOP]`
- `isDoesNotExistError` / `NoSuchThing` The original file does not exist, or there is no path to the target. `[ENOENT, ENOTDIR]`
- `isPermissionError` / `PermissionDenied` The process has insufficient privileges to perform the operation. `[EROFS, EACCES, EPERM]`
- `ResourceExhausted` Insufficient resources are available to perform the operation. `[EDQUOT, ENOSPC, ENOMEM, EMLINK]`
- `UnsatisfiedConstraints` Implementation-dependent constraints are not satisfied. `[EBUSY]`
- `UnsupportedOperation` The implementation does not support renaming in this situation. `[EXDEV]`
- `InappropriateType` Either path refers to an existing directory. `[ENOTDIR, EISDIR, EINVAL, EEXIST, ENOTEMPTY]`

copyFile #

Arguments

:: MonadIO m |
=> Path b0 File | Original location
-> Path b1 File | Where to put copy
-> m () |

``copyFile` old new` copies the existing file from `old` to `new`. If the `new` file already exists, it is atomically replaced by the `old` file. Neither path may refer to an existing directory. The permissions of `old` are copied to `new`, if possible.

findExecutable #

Arguments

:: MonadIO m |
=> Path Rel File | Executable file name
-> m (Maybe (Path Abs File)) | Path to found executable

Given an executable file name, search for such file in the directories listed in system `PATH`. The returned value is the path to the found executable or `Nothing` if an executable with the given name was not found. For example (`findExecutable` "ghc") gives you the path to GHC.

The path returned by `findExecutable` corresponds to the program that would be executed by `createProcess` when passed the same string (as a RawCommand, not a ShellCommand).

On Windows, `findExecutable` calls the Win32 function `SearchPath`, which may search other places before checking the directories in `PATH`. Where it actually searches depends on registry settings, but notably includes the directory containing the current executable. See http://msdn.microsoft.com/en-us/library/aa365527.aspx for more details.

findFile #

Arguments

:: (MonadIO m, MonadThrow m) |
=> [Path b Dir] | Set of directories to search in
-> Path Rel File | Filename of interest
-> m (Maybe (Path Abs File)) | Absolute path to file (if found)

Search through the given set of directories for the given file.

findFiles #

Arguments

:: (MonadIO m, MonadThrow m) |
=> [Path b Dir] | Set of directories to search in
-> Path Rel File | Filename of interest
-> m [Path Abs File] | Absolute paths to all found files

Search through the given set of directories for the given file and return a list of paths where the given file exists.

findFilesWith #

Arguments

:: (MonadIO m, MonadThrow m) |
=> (Path Abs File -> m Bool) | How to test the files
-> [Path b Dir] | Set of directories to search in
-> Path Rel File | Filename of interest
-> m [Path Abs File] | Absolute paths to all found files

Search through the given set of directories for the given file and with the given property (usually permissions) and return a list of paths where the given file exists and has the property.

# Temporary files and directories

withTempFile #

Arguments

:: (MonadIO m, MonadMask m) |
=> Path b Dir | Directory to create the file in
-> String | File name template, see `openTempFile`
-> (Path Abs File -> Handle -> m a) | Callback that can use the file
-> m a |

Use a temporary file that doesn't already exist.

Creates a new temporary file inside the given directory, making use of the template. The temporary file is deleted after use.

Since: 0.2.0

withTempDir #

Arguments

:: (MonadIO m, MonadMask m) |
=> Path b Dir | Directory to create the file in
-> String | Directory name template, see `openTempFile`
-> (Path Abs Dir -> m a) | Callback that can use the directory
-> m a |

Create and use a temporary directory.

Creates a new temporary directory inside the given directory, making use of the template. The temporary directory is deleted after use.

Since: 0.2.0

withSystemTempFile #

Arguments

:: (MonadIO m, MonadMask m) |
=> String | File name template, see `openTempFile`
-> (Path Abs File -> Handle -> m a) | Callback that can use the file
-> m a |

Create and use a temporary file in the system standard temporary directory.

Behaves exactly the same as `withTempFile`, except that the parent temporary directory will be that returned by `getTempDir`.

Since: 0.2.0

withSystemTempDir #

Arguments

:: (MonadIO m, MonadMask m) |
=> String | Directory name template, see `openTempFile`
-> (Path Abs Dir -> m a) | Callback that can use the directory
-> m a |

Create and use a temporary directory in the system standard temporary directory.

Behaves exactly the same as `withTempDir`, except that the parent temporary directory will be that returned by `getTempDir`.

Since: 0.2.0

openTempFile #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path b Dir | Directory to create file in
-> String | File name template; if the template is "foo.ext" then the created file will be `"fooXXX.ext"` where `XXX` is some random number
-> m (Path Abs File, Handle) | Name of created file and its `Handle`

The function creates a temporary file in `rw` mode. The created file isn't deleted automatically, so you need to delete it manually.

The file is created with permissions such that only the current user can read/write it.

With some exceptions (see below), the file will be created securely in the sense that an attacker should not be able to cause openTempFile to overwrite another file on the filesystem using your credentials, by putting symbolic links (on Unix) in the place where the temporary file is to be created. On Unix the `O_CREAT` and `O_EXCL` flags are used to prevent this attack, but note that `O_EXCL` is sometimes not supported on NFS filesystems, so if you rely on this behaviour it is best to use local filesystems only.

Since: 0.2.0

openBinaryTempFile #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path b Dir | Directory to create file in
-> String | File name template, see `openTempFile`
-> m (Path Abs File, Handle) | Name of created file and its `Handle`

Like `openTempFile`, but opens the file in binary mode. On Windows, reading a file in text mode (which is the default) will translate `CRLF` to `LF`, and writing will translate `LF` to `CRLF`. This is usually what you want with text files. With binary files this is undesirable; also, as usual under Microsoft operating systems, text mode treats control-Z as EOF. Binary mode turns off all special treatment of end-of-line and end-of-file characters.

Since: 0.2.0

createTempDir #

Arguments

:: (MonadIO m, MonadThrow m) |
=> Path b Dir | Directory to create file in
-> String | Directory name template, see `openTempFile`
-> m (Path Abs Dir) | Name of created temporary directory

Create temporary directory. The created directory isn't deleted automatically, so you need to delete it manually.

The directory is created with permissions such that only the current user can read/write it.

Since: 0.2.0

# Existence tests

doesFileExist :: MonadIO m => Path b File -> m Bool #

The operation `doesFileExist` returns `True` if the argument file exists and is not a directory, and `False` otherwise.

doesDirExist :: MonadIO m => Path b Dir -> m Bool #

The operation `doesDirExist` returns `True` if the argument file exists and is either a directory or a symbolic link to a directory, and `False` otherwise.

isLocationOccupied :: MonadIO m => Path b t -> m Bool #

Check if there is a file or directory on specified path.

forgivingAbsence :: (MonadIO m, MonadCatch m) => m a -> m (Maybe a) #

If argument of the function throws a `doesNotExistErrorType`, `Nothing` is returned (other exceptions propagate). Otherwise the result is returned inside a `Just`.

Since: 0.3.0

ignoringAbsence :: (MonadIO m, MonadCatch m) => m a -> m () #

The same as `forgivingAbsence`, but ignores result.

Since: 0.3.1

# Permissions

data Permissions :: * #

Instances

Eq Permissions |
Methods (==) :: Permissions -> Permissions -> Bool # (/=) :: Permissions -> Permissions -> Bool #
Ord Permissions |
Methods compare :: Permissions -> Permissions -> Ordering # (<) :: Permissions -> Permissions -> Bool # (<=) :: Permissions -> Permissions -> Bool # (>) :: Permissions -> Permissions -> Bool # (>=) :: Permissions -> Permissions -> Bool # max :: Permissions -> Permissions -> Permissions # min :: Permissions -> Permissions -> Permissions #
Read Permissions |
Methods readsPrec :: Int -> ReadS Permissions # readList :: ReadS [Permissions] # readPrec :: ReadPrec Permissions # readListPrec :: ReadPrec [Permissions] #
Show Permissions |
Methods showsPrec :: Int -> Permissions -> ShowS # show :: Permissions -> String # showList :: [Permissions] -> ShowS #

emptyPermissions :: Permissions #

readable :: Permissions -> Bool #

writable :: Permissions -> Bool #

executable :: Permissions -> Bool #

searchable :: Permissions -> Bool #

setOwnerReadable :: Bool -> Permissions -> Permissions #

setOwnerWritable :: Bool -> Permissions -> Permissions #

setOwnerExecutable :: Bool -> Permissions -> Permissions #

setOwnerSearchable :: Bool -> Permissions -> Permissions #

getPermissions :: MonadIO m => Path b t -> m Permissions #

The `getPermissions` operation returns the permissions for the file or directory.

The operation may fail with:

- `isPermissionError` if the user is not permitted to access the permissions; or
- `isDoesNotExistError` if the file or directory does not exist.

setPermissions :: MonadIO m => Path b t -> Permissions -> m () #

The `setPermissions` operation sets the permissions for the file or directory.

The operation may fail with:

- `isPermissionError` if the user is not permitted to set the permissions; or
- `isDoesNotExistError` if the file or directory does not exist.

copyPermissions #

Arguments

:: MonadIO m |
=> Path b0 t0 | From where to copy
-> Path b1 t1 | What to modify
-> m () |

Set permissions for the object found on second given path so they match permissions of the object on the first path.

# Timestamps

getAccessTime :: MonadIO m => Path b t -> m UTCTime #

Obtain the time at which the file or directory was last accessed.

The operation may fail with:

- `isPermissionError` if the user is not permitted to read the access time; or
- `isDoesNotExistError` if the file or directory does not exist.

Caveat for POSIX systems: This function returns a timestamp with sub-second resolution only if this package is compiled against `unix-2.6.0.0` or later and the underlying filesystem supports them.

Note: this is a piece of conditional API, only available if `directory-1.2.3.0` or later is used.

setAccessTime :: MonadIO m => Path b t -> UTCTime -> m () #

Change the time at which the file or directory was last accessed.

The operation may fail with:

- `isPermissionError` if the user is not permitted to alter the access time; or
- `isDoesNotExistError` if the file or directory does not exist.

Some caveats for POSIX systems:

- Not all systems support `utimensat`, in which case the function can only emulate the behavior by reading the modification time and then setting both the access and modification times together. On systems where `utimensat` is supported, the access time is set atomically with nanosecond precision.
- If compiled against a version of `unix` prior to `2.7.0.0`, the function would not be able to set timestamps with sub-second resolution. In this case, there would also be loss of precision in the modification time.

Note: this is a piece of conditional API, only available if `directory-1.2.3.0` or later is used.

setModificationTime :: MonadIO m => Path b t -> UTCTime -> m () #

Change the time at which the file or directory was last modified.

The operation may fail with:

- `isPermissionError` if the user is not permitted to alter the modification time; or
- `isDoesNotExistError` if the file or directory does not exist.

Some caveats for POSIX systems:

- Not all systems support `utimensat`, in which case the function can only emulate the behavior by reading the access time and then setting both the access and modification times together. On systems where `utimensat` is supported, the modification time is set atomically with nanosecond precision.
- If compiled against a version of `unix` prior to `2.7.0.0`, the function would not be able to set timestamps with sub-second resolution. In this case, there would also be loss of precision in the access time.

Note: this is a piece of conditional API, only available if `directory-1.2.3.0` or later is used.

getModificationTime :: MonadIO m => Path b t -> m UTCTime #

Obtain the time at which the file or directory was last modified.

The operation may fail with:

- `isPermissionError` if the user is not permitted to read the modification time; or
- `isDoesNotExistError` if the file or directory does not exist.

Caveat for POSIX systems: This function returns a timestamp with sub-second resolution only if this package is compiled against `unix-2.6.0.0` or later and the underlying filesystem supports them.