Path.IO

IO actions that might be put in a package at some point.

Documentation

getWorkingDir :: MonadIO m => m (Path Abs Dir)

Get the current working directory.

parseRelAsAbsDir :: (MonadThrow m, MonadIO m) => FilePath -> m (Path Abs Dir)

Parse a directory path. If it's relative, then the absolute version is yielded, based off the working directory.

parseRelAsAbsFile :: (MonadThrow m, MonadIO m) => FilePath -> m (Path Abs File)

Parse a file path. If it's relative, then the absolute version is yielded, based off the working directory.

listDirectory :: (MonadIO m, MonadThrow m) => Path Abs Dir -> m ([Path Abs Dir], [Path Abs File])

List objects in a directory, excluding "." and "..". Entries are not sorted.

resolveDir :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs Dir)

Appends a stringly-typed relative path to an absolute path, and then canonicalizes it.

resolveFile :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs File)

Appends a stringly-typed relative path to an absolute path, and then canonicalizes it.

resolveDirMaybe :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Maybe (Path Abs Dir))

Appends a stringly-typed relative path to an absolute path, and then canonicalizes it. If the path doesn't exist (and therefore cannot be canonicalized, Nothing is returned).

resolveFileMaybe :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Maybe (Path Abs File))

Appends a stringly-typed relative path to an absolute path, and then canonicalizes it. If the path doesn't exist (and therefore cannot be canonicalized, Nothing is returned).

data ResolveException

Constructors

ResolveDirFailed (Path Abs Dir) FilePath FilePath

ResolveFileFailed (Path Abs Dir) FilePath FilePath

Instances

Show ResolveException

Methods

showsPrec :: Int -> ResolveException -> ShowS

show :: ResolveException -> String

showList :: [ResolveException] -> ShowS

Exception ResolveException

Methods

toException :: ResolveException -> SomeException

fromException :: SomeException -> Maybe ResolveException

displayException :: ResolveException -> String

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

Remove a file. Bails out if it doesn't exist.

removeFileIfExists :: MonadIO m => Path b File -> m ()

Remove a file. Optimistically assumes it exists. If it doesn't, doesn't complain.

removeTree :: MonadIO m => Path b Dir -> m ()

Remove a tree. Bails out if it doesn't exist.

removeTreeIfExists :: MonadIO m => Path b Dir -> m ()

Remove tree, don't complain about non-existent directories.

renameFile :: MonadIO m => Path b1 File -> Path b2 File -> m ()

Rename a file. Bails out if it doesn't exist.

renameFileIfExists :: MonadIO m => Path b1 File -> Path b2 File -> m ()

Rename a file. Optimistically assumes it exists. If it doesn't, doesn't complain.

renameDir :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

renameDirIfExists :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

Rename a directory. Optimistically assumes it exists. If it doesn't, doesn't complain.

moveFile :: MonadIO m => Path b1 File -> Path b2 Dir -> m ()

Move a file. Bails out if it doesn't exist.

moveFileIfExists :: MonadIO m => Path b1 File -> Path b2 Dir -> m ()

Move a file. Optimistically assumes it exists. If it doesn't, doesn't complain.

moveDir :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

Move a dir. Bails out if it doesn't exist.

moveDirIfExists :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

Move a dir. Optimistically assumes it exists. If it doesn't, doesn't complain.

fileExists :: MonadIO m => Path b File -> m Bool

Does the file exist?

dirExists :: MonadIO m => Path b Dir -> m Bool

Does the directory exist?

copyFile :: MonadIO m => Path b1 File -> Path b2 File -> m ()

Copies a file to another path. Bails out if it doesn't exist.

copyFileIfExists :: MonadIO m => Path b1 File -> Path b2 File -> m ()

Copies a file to another path. Optimistically assumes it exists. If it doesn't, doesn't complain.

copyDirectoryRecursive

Arguments

:: (MonadIO m, MonadThrow m)

=> Path Abs Dir

Source directory

-> Path Abs Dir

Destination directory

-> m ()

Copy a directory recursively. This just uses copyFile, so it is not smart about symbolic links or other special files.

createTree :: MonadIO m => Path b Dir -> m ()

Make a directory tree, creating parents if needed.

dropRoot :: Path Abs t -> Path Rel t

Drop the root (either / on POSIX or C:\, D:\, etc. on Windows).

parseCollapsedAbsFile :: MonadThrow m => FilePath -> m (Path Abs File)

Collapse intermediate "." and ".." directories from path, then parse it with parseAbsFile. (probably should be moved to the Path module)

parseCollapsedAbsDir :: MonadThrow m => FilePath -> m (Path Abs Dir)

Collapse intermediate "." and ".." directories from path, then parse it with parseAbsDir. (probably should be moved to the Path module)

withCanonicalizedSystemTempDirectory

Arguments

:: (MonadMask m, MonadIO m)

=> String

Directory name template.

-> (Path Abs Dir -> m a)

Callback that can use the canonicalized directory

-> m a

withCanonicalizedTempDirectory

Arguments

:: (MonadMask m, MonadIO m)

=> FilePath

Temp directory to create the directory in

-> String

Directory name template.

-> (Path Abs Dir -> m a)

Callback that can use the canonicalized directory

-> m a