-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Platform-agnostic library for filesystem operations -- -- This library provides a basic set of operations for manipulating files -- and directories in a portable way. @package directory @version 1.3.0.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 targets. -- -- On Windows, the operation fails if dir is a directory symbolic -- link. removeDirectoryRecursive :: FilePath -> IO () -- | Removes a file or directory at path together with its contents -- and subdirectories. Symbolic links are removed without affecting their -- targets. If the path does not exist, nothing happens. -- -- Unlike other removal functions, this function will also attempt to -- delete files marked as read-only or otherwise made unremovable due to -- permissions. As a result, if the removal is incomplete, the -- permissions or attributes on the remaining files may be altered. -- -- If an entry within the directory vanishes while -- removePathForcibly is running, it is silently ignored. -- -- If an exception occurs while removing an entry, -- removePathForcibly will still try to remove as many entries -- as it can before failing with an exception. The first exception that -- it encountered is re-thrown. removePathForcibly :: 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 () -- | listDirectory dir returns a list of all entries -- in dir without the special entries (. and -- ..). -- -- The operation may fail with: -- -- listDirectory :: FilePath -> IO [FilePath] -- | Similar to listDirectory, but always includes the special -- entries (. and ..). (This applies to Windows as -- well.) -- -- The operation may fail with the same exceptions as -- listDirectory. 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. 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. 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). getXdgDirectory :: XdgDirectory -> FilePath -> IO FilePath -- | Obtain the path to a special directory for storing user-specific -- application data (traditional Unix location). Newer applications may -- prefer the the XDG-conformant location provided by -- getXdgDirectory (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 () -- | Rename a file or directory. If the destination path already exists, it -- is replaced atomically. The destination path must not point 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: -- -- renamePath :: FilePath -> FilePath -> IO () -- | Copy a file with its permissions. If the destination file already -- exists, it is replaced atomically. Neither path may refer to an -- existing directory. No exceptions are thrown if the permissions could -- not be copied. copyFile :: FilePath -> FilePath -> IO () -- | Copy a file with its associated metadata. If the destination file -- already exists, it is overwritten. There is no guarantee of atomicity -- in the replacement of the destination file. Neither path may refer to -- an existing directory. If the source and/or destination are symbolic -- links, the copy is performed on the targets of the links. -- -- On Windows, it behaves like the Win32 function CopyFile, which -- copies various kinds of metadata including file attributes and -- security resource properties. -- -- On Unix-like systems, permissions, access time, and modification time -- are preserved. If possible, the owner and group are also preserved. -- Note that the very act of copying can change the access time of the -- source file, hence the access times of the two files may differ after -- the operation completes. copyFileWithMetadata :: FilePath -> FilePath -> IO () -- | Make a path absolute, normalise the path, and remove as many -- indirections from it as possible. Any trailing path separators are -- discarded via dropTrailingPathSeparator. Additionally, on -- Windows the letter case of the path is canonicalized. -- -- Note: This function is a very big hammer. If you only need an -- absolute path, makeAbsolute is sufficient for removing -- dependence on the current working directory. -- -- 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. Canonicalization is performed -- on the longest prefix of the path that points to an existing file or -- directory. The remaining portion of the path that does not point to an -- existing file or directory will still undergo normalise, but -- case canonicalization and indirection removal are skipped as they are -- impossible to do on a nonexistent path. -- -- Most programs should not worry about the canonicity of a path. In -- particular, despite the name, the function does not truly guarantee -- canonicity of the returned path due to the presence of hard links, -- mount points, etc. -- -- If the path points to an existing file or directory, then the output -- path shall also point to the same file or directory, subject to the -- condition that the relevant parts of the file system do not change -- while the function is still running. In other words, the function is -- definitively not atomic. The results can be utterly wrong if the -- portions of the path change while this function is running. -- -- Since symbolic links (and, on non-Windows systems, parent directories -- ..) are dependent on the state of the existing filesystem, -- the function can only make a conservative attempt by removing such -- indirections from the longest prefix of the path that still points to -- an existing file or directory. -- -- Note that on Windows parent directories .. are always fully -- expanded before the symbolic links, as consistent with the rest of the -- Windows API (such as GetFullPathName). In contrast, on POSIX -- systems parent directories .. are expanded alongside symbolic -- links from left to right. To put this more concretely: if L -- is a symbolic link for R/P, then on Windows L\.. -- refers to ., whereas on other operating systems L/.. -- refers to R. -- -- Similar to normalise, passing an empty path is equivalent to -- passing the current directory. -- -- Known bugs: When the path contains an existing symbolic link, -- but the target of the link does not exist, then the path is not -- dereferenced (bug #64). Symbolic link expansion is not performed on -- Windows XP or earlier due to the absence of -- GetFinalPathNameByHandle. -- -- Changes since 1.2.3.0: The function has been altered to be more -- robust and has the same exception behavior as makeAbsolute. -- -- Changes since 1.3.0.0: The function no longer preserves the -- trailing path separator. File symbolic links that appear in the middle -- of a path are properly dereferenced. Case canonicalization and -- symbolic link expansion are now performed on Windows. canonicalizePath :: FilePath -> IO FilePath -- | Convert a path into an absolute path. If the given path is relative, -- the current directory is prepended and then the combined result is -- normalised. If the path is already absolute, the path is simply -- normalised. The function preserves the presence or absence of -- the trailing path separator unless the path refers to the root -- directory /. -- -- If the path is already absolute, the operation never fails. Otherwise, -- the operation may fail with the same exceptions as -- getCurrentDirectory. makeAbsolute :: FilePath -> IO FilePath -- | Construct a path relative to the current directory, similar to -- makeRelative. -- -- The operation may fail with the same exceptions as -- getCurrentDirectory. 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. -- -- On Windows, this only returns the first ocurrence, if any. It uses the -- SearchPath from the Win32 API, so the caveats noted in -- findExecutable apply here as well. findExecutables :: String -> IO [FilePath] -- | Given a file name, searches for the file on the given paths and -- returns a list of all occurences that are executable. findExecutablesInDirectories :: [FilePath] -> String -> IO [FilePath] -- | Search through the given set of directories for the given file. 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. 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 the file -- path where the given file exists and has the property. findFileWith :: (FilePath -> IO Bool) -> [FilePath] -> String -> IO (Maybe 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. findFilesWith :: (FilePath -> IO Bool) -> [FilePath] -> String -> IO [FilePath] -- | Filename extension for executable files (including the dot if any) -- (usually "" on POSIX systems and ".exe" on Windows -- or OS/2). exeExtension :: String -- | Obtain the size of a file in bytes. getFileSize :: FilePath -> IO Integer -- | Test whether the given path points to an existing filesystem object. -- If the user lacks necessary permissions to search the parent -- directories, this function may return false even if the file does -- actually exist. doesPathExist :: FilePath -> IO Bool -- | 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 -- | Check whether the path refers to a symbolic link. On Windows, this -- tests for FILE_ATTRIBUTE_REPARSE_POINT. pathIsSymbolicLink :: 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. 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: -- -- 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: -- -- setModificationTime :: FilePath -> UTCTime -> IO () -- | Deprecated: Use pathIsSymbolicLink instead isSymbolicLink :: FilePath -> IO Bool instance GHC.Show.Show System.Directory.XdgDirectory instance GHC.Read.Read System.Directory.XdgDirectory instance GHC.Classes.Ord System.Directory.XdgDirectory instance GHC.Classes.Eq System.Directory.XdgDirectory instance GHC.Enum.Enum System.Directory.XdgDirectory instance GHC.Enum.Bounded System.Directory.XdgDirectory instance GHC.Show.Show System.Directory.DirectoryType instance GHC.Read.Read System.Directory.DirectoryType instance GHC.Classes.Ord System.Directory.DirectoryType instance GHC.Classes.Eq System.Directory.DirectoryType instance GHC.Enum.Enum System.Directory.DirectoryType instance GHC.Show.Show System.Directory.Permissions instance GHC.Read.Read System.Directory.Permissions instance GHC.Classes.Ord System.Directory.Permissions instance GHC.Classes.Eq System.Directory.Permissions