-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Platform-agnostic library for filesystem operations -- @package directory @version 1.2.3.1 -- | System-independent interface to directory manipulation. module System.Directory -- | createDirectory 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: -- -- createDirectory :: FilePath -> IO () -- | createDirectoryIfMissing 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. createDirectoryIfMissing :: Bool -> FilePath -> IO () -- | removeDirectory 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: -- -- removeDirectory :: FilePath -> IO () -- | removeDirectoryRecursive dir removes an existing -- directory dir together with its contents and subdirectories. -- Within this directory, symbolic links are removed without affecting -- their the targets. removeDirectoryRecursive :: FilePath -> IO () -- | renameDirectory 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 removeDirectory. 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, renameDirectory fails if the new -- directory already exists. -- -- The operation may fail with: -- -- renameDirectory :: FilePath -> FilePath -> IO () -- | getDirectoryContents dir returns a list of all -- entries in dir. -- -- The operation may fail with: -- -- getDirectoryContents :: FilePath -> IO [FilePath] -- | 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: -- -- getCurrentDirectory :: IO FilePath -- | 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: -- -- setCurrentDirectory :: FilePath -> IO () -- | 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 -- getCurrentDirectory and setCurrentDirectory. -- -- @since 1.2.3.0 withCurrentDirectory :: FilePath -> IO a -> IO a -- | 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 getXdgDirectory or -- getAppUserDataDirectory instead. -- -- On Unix, getHomeDirectory 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: -- -- getHomeDirectory :: IO FilePath -- | 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 data XdgDirectory -- | 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. XdgData :: XdgDirectory -- | 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. XdgConfig :: XdgDirectory -- | 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. XdgCache :: XdgDirectory -- | 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 -- getAppUserDataDirectory, 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. -- -- The second argument is usually the name of the application. Since it -- will be integrated into the path, it must consist of valid path -- characters. -- -- 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). -- -- @since 1.2.3.0 getXdgDirectory :: XdgDirectory -> FilePath -> IO FilePath -- | Obtain the path to a special directory for storing user-specific -- application data (traditional Unix location). Except for backward -- compatibility reasons, newer applications may prefer the the -- XDG-conformant location provided by getXdgDirectory, which -- offers a more fine-grained hierarchy as well as greater flexibility -- for the user (migration guide). -- -- The argument is usually the name of the application. Since it will be -- integrated into the path, it must consist of valid path characters. -- -- -- -- 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: -- -- getAppUserDataDirectory :: FilePath -> IO FilePath -- | 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 getXdgDirectory or -- getAppUserDataDirectory instead. -- -- On Unix, getUserDocumentsDirectory 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: -- -- getUserDocumentsDirectory :: IO FilePath -- | Returns the current directory for temporary files. -- -- On Unix, getTemporaryDirectory 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: -- -- -- -- The operation may fail with: -- -- -- -- The function doesn't verify whether the path exists. getTemporaryDirectory :: IO FilePath -- | 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: -- -- removeFile :: FilePath -> IO () -- | 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: -- -- renameFile :: FilePath -> FilePath -> IO () -- | 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. copyFile :: FilePath -> FilePath -> IO () -- | 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. -- -- Changes since 1.2.3.0: The function has been altered to be more -- robust and has the same exception behavior as makeAbsolute. canonicalizePath :: FilePath -> IO FilePath -- | 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. -- -- @since 1.2.2.0 makeAbsolute :: FilePath -> IO FilePath -- | makeRelative the current directory. makeRelativeToCurrentDirectory :: FilePath -> IO FilePath -- | Given an executable file name, searches 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. findExecutable :: String -> IO (Maybe FilePath) -- | Given a file name, searches for the file and returns a list of all -- occurences that are executable. -- -- @since 1.2.2.0 findExecutables :: String -> IO [FilePath] -- | Search through the given set of directories for the given file. Used -- by findExecutable on non-windows platforms. findFile :: [FilePath] -> String -> IO (Maybe FilePath) -- | Search through the given set of directories for the given file and -- returns a list of paths where the given file exists. -- -- @since 1.2.1.0 findFiles :: [FilePath] -> String -> IO [FilePath] -- | Search through the given set of directories for the given file and -- with the given property (usually permissions) and returns a list of -- paths where the given file exists and has the property. -- -- @since 1.2.1.0 findFilesWith :: (FilePath -> IO Bool) -> [FilePath] -> String -> IO [FilePath] -- | The operation doesFileExist returns True if the argument -- file exists and is not a directory, and False otherwise. doesFileExist :: FilePath -> IO Bool -- | The operation doesDirectoryExist returns True if the -- argument file exists and is either a directory or a symbolic link to a -- directory, and False otherwise. doesDirectoryExist :: FilePath -> IO Bool 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 -- | The getPermissions operation returns the permissions for the -- file or directory. -- -- The operation may fail with: -- -- getPermissions :: FilePath -> IO Permissions -- | The setPermissions operation sets the permissions for the file -- or directory. -- -- The operation may fail with: -- -- setPermissions :: FilePath -> Permissions -> IO () copyPermissions :: FilePath -> FilePath -> IO () -- | Obtain the time at which the file or directory was last accessed. -- -- The operation may fail with: -- -- -- -- 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. -- -- @since 1.2.3.0 getAccessTime :: FilePath -> IO UTCTime -- | Obtain the time at which the file or directory was last modified. -- -- The operation may fail with: -- -- -- -- 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. getModificationTime :: FilePath -> IO UTCTime -- | Change the time at which the file or directory was last accessed. -- -- The operation may fail with: -- -- -- -- Some caveats for POSIX systems: -- -- -- -- @since 1.2.3.0 setAccessTime :: FilePath -> UTCTime -> IO () -- | Change the time at which the file or directory was last modified. -- -- The operation may fail with: -- -- -- -- Some caveats for POSIX systems: -- -- -- -- @since 1.2.3.0 setModificationTime :: FilePath -> UTCTime -> IO () instance Eq Permissions instance Ord Permissions instance Read Permissions instance Show Permissions instance Enum DirectoryType instance Eq DirectoryType instance Ord DirectoryType instance Read DirectoryType instance Show DirectoryType instance Bounded XdgDirectory instance Enum XdgDirectory instance Eq XdgDirectory instance Ord XdgDirectory instance Read XdgDirectory instance Show XdgDirectory