System.Path.Directory

This module provides type-safe access to directory manipulations.

It is designed to be imported instead of System.Directory. (It is intended to provide versions of functions from that module which have equivalent functionality but are more typesafe). System.Path is a companion module providing a type-safe alternative to System.FilePath.

You will typically want to import as follows:

import Prelude hiding (FilePath)
import System.Path
import System.Path.Directory
import System.Path.IO

Ben Moseley - (c) 2009

Actions on directories

createDirectory :: AbsRel ar => DirPath ar -> IO ()

createDirectoryIfMissing :: AbsRel ar => Bool -> DirPath ar -> IO ()

removeDirectory :: AbsRel ar => DirPath ar -> IO ()

removeDirectoryRecursive :: AbsRel ar => DirPath ar -> IO ()

renameDirectory :: (AbsRel ar1, AbsRel ar2) => DirPath ar1 -> DirPath ar2 -> IO ()

getDirectoryContents :: AbsRel ar => DirPath ar -> IO [RelFileDir]

Retrieve the contents of a directory without any directory prefixes. In contrast to getDirectoryContents, exclude special directories "." and "..".

absDirectoryContents :: AbsRel ar => DirPath ar -> IO ([AbsDir], [AbsFile])

Retrieve the contents of a directory path (which may be relative) as absolute paths

relDirectoryContents :: AbsRel ar => DirPath ar -> IO ([RelDir], [RelFile])

Returns paths relative to the supplied (abs or relative) directory path. eg (for current working directory of /somewhere/cwd/):

show (relDirectoryContents "d/e/f/") == (["subDir1A","subDir1B"],
                                                     ["file1A","file1B"])

filesInDir :: AbsRel ar => DirPath ar -> IO [RelFile]

A convenient alternative to relDirectoryContents if you only want files.

dirsInDir :: AbsRel ar => DirPath ar -> IO [RelDir]

A convenient alternative to relDirectoryContents if you only want directories.

getCurrentDirectory :: IO AbsDir

setCurrentDirectory :: AbsRel ar => DirPath ar -> IO ()

Pre-defined directories

getHomeDirectory :: IO AbsDir

getAppUserDataDirectory :: String -> IO AbsDir

getUserDocumentsDirectory :: IO AbsDir

getTemporaryDirectory :: IO AbsDir

Actions on files

removeFile :: AbsRel ar => FilePath ar -> IO ()

renameFile :: (AbsRel ar1, AbsRel ar2) => FilePath ar1 -> FilePath ar2 -> IO ()

copyFile :: (AbsRel ar1, AbsRel ar2) => FilePath ar1 -> FilePath ar2 -> IO ()

canonicalizePath :: (AbsRel ar, FileDir fd) => Path ar fd -> IO (AbsPath fd)

makeRelativeToCurrentDirectory :: (AbsRel ar, FileDir fd) => Path ar fd -> IO (RelPath fd)

findExecutable :: String -> IO (Maybe AbsFile)

Existence tests

doesFileExist :: AbsRel ar => FilePath ar -> IO Bool

doesDirectoryExist :: AbsRel ar => DirPath ar -> IO Bool

Permissions

data Permissions

Instances

Eq Permissions

Defined in System.Directory.Internal.Common

Methods

(==) :: Permissions -> Permissions -> Bool

(/=) :: Permissions -> Permissions -> Bool

Ord Permissions

Defined in System.Directory.Internal.Common

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

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS Permissions

readList :: ReadS [Permissions]

readPrec :: ReadPrec Permissions

readListPrec :: ReadPrec [Permissions]

Show Permissions

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> Permissions -> ShowS

show :: Permissions -> String

showList :: [Permissions] -> ShowS

getPermissions :: (AbsRel ar, FileDir fd) => Path ar fd -> IO Permissions

setPermissions :: (AbsRel ar, FileDir fd) => Path ar fd -> Permissions -> IO ()

Timestamps

getModificationTime :: (AbsRel ar, FileDir fd) => Path ar fd -> IO UTCTime