Stability	unstable
Portability	unportable
Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Directory.Internal

Description

Internal modules are always subject to change from version to version. The contents of this module are also platform-dependent, hence what is shown in the Hackage documentation may differ from what is actually available on your system.

Synopsis

newtype ListT m a = ListT {
- unListT :: m (Maybe (a, ListT m a))
}
emptyListT :: Applicative m => ListT m a
maybeToListT :: Applicative m => m (Maybe a) -> ListT m a
listToListT :: Applicative m => [a] -> ListT m a
liftJoinListT :: Monad m => m (ListT m a) -> ListT m a
listTHead :: Functor m => ListT m a -> m (Maybe a)
listTToList :: Monad m => ListT m a -> m [a]
andM :: Monad m => m Bool -> m Bool -> m Bool
sequenceWithIOErrors_ :: [IO ()] -> IO ()
tryIOErrorType :: (IOError -> Bool) -> IO a -> IO (Either IOError a)
ignoreIOExceptions :: IO () -> IO ()
specializeErrorString :: String -> (IOError -> Bool) -> IO a -> IO a
ioeAddLocation :: IOError -> String -> IOError
expandDots :: [FilePath] -> [FilePath]
normalisePathSeps :: FilePath -> FilePath
normaliseTrailingSep :: FilePath -> FilePath
emptyToCurDir :: FilePath -> FilePath
simplifyPosix :: FilePath -> FilePath
simplifyWindows :: FilePath -> FilePath
data FileType
- = File
- | SymbolicLink
- | Directory
- | DirectoryLink
fileTypeIsDirectory :: FileType -> Bool
fileTypeIsLink :: FileType -> Bool
data Permissions = Permissions {
- readable :: Bool
- writable :: Bool
- executable :: Bool
- searchable :: Bool
}
copyFileContents :: FilePath -> FilePath -> IO ()
copyFileToHandle :: FilePath -> Handle -> IO ()
copyHandleData :: Handle -> Handle -> IO ()
data XdgDirectory
- = XdgData
- | XdgConfig
- | XdgCache
data XdgDirectoryList
- = XdgDataDirs
- | XdgConfigDirs
createDirectoryInternal :: FilePath -> IO ()
removePathInternal :: Bool -> FilePath -> IO ()
renamePathInternal :: FilePath -> FilePath -> IO ()
simplify :: FilePath -> FilePath
c_free :: Ptr a -> IO ()
c_PATH_MAX :: Maybe Int
c_realpath :: CString -> CString -> IO CString
withRealpath :: CString -> (CString -> IO a) -> IO a
canonicalizePathWith :: ((FilePath -> IO FilePath) -> FilePath -> IO FilePath) -> FilePath -> IO FilePath
canonicalizePathSimplify :: FilePath -> IO FilePath
findExecutablesLazyInternal :: ([FilePath] -> String -> ListT IO FilePath) -> String -> ListT IO FilePath
exeExtensionInternal :: String
getDirectoryContentsInternal :: FilePath -> IO [FilePath]
getCurrentDirectoryInternal :: IO FilePath
prependCurrentDirectory :: FilePath -> IO FilePath
setCurrentDirectoryInternal :: FilePath -> IO ()
linkToDirectoryIsDirectory :: Bool
createSymbolicLink :: Bool -> FilePath -> FilePath -> IO ()
readSymbolicLink :: FilePath -> IO FilePath
type Metadata = FileStatus
getSymbolicLinkMetadata :: FilePath -> IO Metadata
getFileMetadata :: FilePath -> IO Metadata
fileTypeFromMetadata :: Metadata -> FileType
fileSizeFromMetadata :: Metadata -> Integer
accessTimeFromMetadata :: Metadata -> UTCTime
modificationTimeFromMetadata :: Metadata -> UTCTime
posix_accessTimeHiRes :: FileStatus -> POSIXTime
posix_modificationTimeHiRes :: FileStatus -> POSIXTime
type Mode = FileMode
modeFromMetadata :: Metadata -> Mode
allWriteMode :: FileMode
hasWriteMode :: Mode -> Bool
setWriteMode :: Bool -> Mode -> Mode
setFileMode :: FilePath -> Mode -> IO ()
setFilePermissions :: FilePath -> Mode -> IO ()
getAccessPermissions :: FilePath -> IO Permissions
setAccessPermissions :: FilePath -> Permissions -> IO ()
copyOwnerFromStatus :: FileStatus -> FilePath -> IO ()
copyGroupFromStatus :: FileStatus -> FilePath -> IO ()
tryCopyOwnerAndGroupFromStatus :: FileStatus -> FilePath -> IO ()
copyFileWithMetadataInternal :: (Metadata -> FilePath -> IO ()) -> (Metadata -> FilePath -> IO ()) -> FilePath -> FilePath -> IO ()
setTimes :: FilePath -> (Maybe POSIXTime, Maybe POSIXTime) -> IO ()
getPath :: IO [FilePath]
getHomeDirectoryInternal :: IO FilePath
getXdgDirectoryFallback :: IO FilePath -> XdgDirectory -> IO FilePath
getXdgDirectoryListFallback :: XdgDirectoryList -> IO [FilePath]
getAppUserDataDirectoryInternal :: FilePath -> IO FilePath
getUserDocumentsDirectoryInternal :: IO FilePath
getTemporaryDirectoryInternal :: IO FilePath

Documentation

newtype ListT m a Source #

A generator with side-effects.

Constructors

ListT
Fields unListT :: m (Maybe (a, ListT m a))

emptyListT :: Applicative m => ListT m a Source #

maybeToListT :: Applicative m => m (Maybe a) -> ListT m a Source #

listToListT :: Applicative m => [a] -> ListT m a Source #

liftJoinListT :: Monad m => m (ListT m a) -> ListT m a Source #

listTHead :: Functor m => ListT m a -> m (Maybe a) Source #

listTToList :: Monad m => ListT m a -> m [a] Source #

andM :: Monad m => m Bool -> m Bool -> m Bool Source #

sequenceWithIOErrors_ :: [IO ()] -> IO () Source #

tryIOErrorType :: (IOError -> Bool) -> IO a -> IO (Either IOError a) Source #

Similar to try but only catches a specify kind of IOError as specified by the predicate.

ignoreIOExceptions :: IO () -> IO () Source #

Attempt to perform the given action, silencing any IO exception thrown by it.

specializeErrorString :: String -> (IOError -> Bool) -> IO a -> IO a Source #

ioeAddLocation :: IOError -> String -> IOError Source #

expandDots :: [FilePath] -> [FilePath] Source #

Given a list of path segments, expand . and ... The path segments must not contain path separators.

normalisePathSeps :: FilePath -> FilePath Source #

Convert to the right kind of slashes.

normaliseTrailingSep :: FilePath -> FilePath Source #

Remove redundant trailing slashes and pick the right kind of slash.

emptyToCurDir :: FilePath -> FilePath Source #

Convert empty paths to the current directory, otherwise leave it unchanged.

simplifyPosix :: FilePath -> FilePath Source #

Similar to normalise but empty paths stay empty.

simplifyWindows :: FilePath -> FilePath Source #

Similar to normalise but:

empty paths stay empty,
parent dirs (..) are expanded, and
paths starting with \\?\ are preserved.

The goal is to preserve the meaning of paths better than normalise.

data FileType Source #

Constructors

File
SymbolicLink	POSIX: either file or directory link; Windows: file link
Directory
DirectoryLink	Windows only: directory link

Instances

Instances details

Bounded FileType #
Instance details Defined in System.Directory.Internal.Common Methods minBound :: FileType Source # maxBound :: FileType Source #
Enum FileType #
Instance details Defined in System.Directory.Internal.Common Methods succ :: FileType -> FileType Source # pred :: FileType -> FileType Source # toEnum :: Int -> FileType Source # fromEnum :: FileType -> Int Source # enumFrom :: FileType -> [FileType] Source # enumFromThen :: FileType -> FileType -> [FileType] Source # enumFromTo :: FileType -> FileType -> [FileType] Source # enumFromThenTo :: FileType -> FileType -> FileType -> [FileType] Source #
Eq FileType #
Instance details Defined in System.Directory.Internal.Common Methods (==) :: FileType -> FileType -> Bool # (/=) :: FileType -> FileType -> Bool #
Ord FileType #
Instance details Defined in System.Directory.Internal.Common Methods compare :: FileType -> FileType -> Ordering # (<) :: FileType -> FileType -> Bool # (<=) :: FileType -> FileType -> Bool # (>) :: FileType -> FileType -> Bool # (>=) :: FileType -> FileType -> Bool # max :: FileType -> FileType -> FileType # min :: FileType -> FileType -> FileType #
Read FileType #
Instance details Defined in System.Directory.Internal.Common Methods readsPrec :: Int -> ReadS FileType Source # readList :: ReadS [FileType] Source # readPrec :: ReadPrec FileType Source # readListPrec :: ReadPrec [FileType] Source #
Show FileType #
Instance details Defined in System.Directory.Internal.Common Methods showsPrec :: Int -> FileType -> ShowS Source # show :: FileType -> String Source # showList :: [FileType] -> ShowS Source #

fileTypeIsDirectory :: FileType -> Bool Source #

Check whether the given FileType is considered a directory by the operating system. This affects the choice of certain functions e.g. removeDirectory vs removeFile.

fileTypeIsLink :: FileType -> Bool Source #

Return whether the given FileType is a link.

data Permissions Source #

Constructors

Permissions
Fields readable :: Bool writable :: Bool executable :: Bool searchable :: Bool

Instances

Instances details

Eq Permissions #
Instance details Defined in System.Directory.Internal.Common Methods (==) :: Permissions -> Permissions -> Bool # (/=) :: Permissions -> Permissions -> Bool #
Ord Permissions #
Instance details 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 #
Instance details Defined in System.Directory.Internal.Common Methods readsPrec :: Int -> ReadS Permissions Source # readList :: ReadS [Permissions] Source # readPrec :: ReadPrec Permissions Source # readListPrec :: ReadPrec [Permissions] Source #
Show Permissions #
Instance details Defined in System.Directory.Internal.Common Methods showsPrec :: Int -> Permissions -> ShowS Source # show :: Permissions -> String Source # showList :: [Permissions] -> ShowS Source #

copyFileContents Source #

Arguments

:: FilePath	Source filename
-> FilePath	Destination filename
-> IO ()

Truncate the destination file and then copy the contents of the source file to the destination file. If the destination file already exists, its attributes shall remain unchanged. Otherwise, its attributes are reset to the defaults.

copyFileToHandle Source #

Arguments

:: FilePath	Source file
-> Handle	Destination handle
-> IO ()

Copy all data from a file to a handle.

copyHandleData Source #

Arguments

:: Handle	Source handle
-> Handle	Destination handle
-> IO ()

Copy data from one handle to another until end of file.

data XdgDirectory Source #

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 usually map to the same directory.

Since: directory-1.2.3.0

Constructors

XdgData	For data files (e.g. images). It uses the `XDG_DATA_HOME` environment variable. On non-Windows systems, the default is `~/.local/share`. On Windows, the default is `%APPDATA%` (e.g. `C:/Users/<user>/AppData/Roaming`). Can be considered as the user-specific equivalent of `/usr/share`.
XdgConfig	For configuration files. It uses the `XDG_CONFIG_HOME` environment variable. On non-Windows systems, the default is `~/.config`. On Windows, the default 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). It uses the `XDG_CACHE_HOME` environment variable. On non-Windows systems, the default is `~/.cache`. On Windows, the default is `%LOCALAPPDATA%` (e.g. `C:/Users/<user>/AppData/Local`). Can be considered as the user-specific equivalent of `/var/cache`.

Instances

Instances details

Bounded XdgDirectory #
Instance details Defined in System.Directory.Internal.Common Methods minBound :: XdgDirectory Source # maxBound :: XdgDirectory Source #
Enum XdgDirectory #
Instance details Defined in System.Directory.Internal.Common Methods succ :: XdgDirectory -> XdgDirectory Source # pred :: XdgDirectory -> XdgDirectory Source # toEnum :: Int -> XdgDirectory Source # fromEnum :: XdgDirectory -> Int Source # enumFrom :: XdgDirectory -> [XdgDirectory] Source # enumFromThen :: XdgDirectory -> XdgDirectory -> [XdgDirectory] Source # enumFromTo :: XdgDirectory -> XdgDirectory -> [XdgDirectory] Source # enumFromThenTo :: XdgDirectory -> XdgDirectory -> XdgDirectory -> [XdgDirectory] Source #
Eq XdgDirectory #
Instance details Defined in System.Directory.Internal.Common Methods (==) :: XdgDirectory -> XdgDirectory -> Bool # (/=) :: XdgDirectory -> XdgDirectory -> Bool #
Ord XdgDirectory #
Instance details Defined in System.Directory.Internal.Common 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 #
Instance details Defined in System.Directory.Internal.Common Methods readsPrec :: Int -> ReadS XdgDirectory Source # readList :: ReadS [XdgDirectory] Source # readPrec :: ReadPrec XdgDirectory Source # readListPrec :: ReadPrec [XdgDirectory] Source #
Show XdgDirectory #
Instance details Defined in System.Directory.Internal.Common Methods showsPrec :: Int -> XdgDirectory -> ShowS Source # show :: XdgDirectory -> String Source # showList :: [XdgDirectory] -> ShowS Source #

data XdgDirectoryList Source #

Search paths for various application data, as specified by the XDG Base Directory Specification.

The list of paths is split using searchPathSeparator, which on Windows is a semicolon.

Note: On Windows, XdgDataDirs and XdgConfigDirs usually yield the same result.

Since: directory-1.3.2.0

Constructors

XdgDataDirs	For data files (e.g. images). It uses the `XDG_DATA_DIRS` environment variable. On non-Windows systems, the default is `/usr/local/share/` and `/usr/share/`. On Windows, the default is `%PROGRAMDATA%` or `%ALLUSERSPROFILE%` (e.g. `C:/ProgramData`).
XdgConfigDirs	For configuration files. It uses the `XDG_CONFIG_DIRS` environment variable. On non-Windows systems, the default is `/etc/xdg`. On Windows, the default is `%PROGRAMDATA%` or `%ALLUSERSPROFILE%` (e.g. `C:/ProgramData`).

Instances

Instances details

Bounded XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods minBound :: XdgDirectoryList Source # maxBound :: XdgDirectoryList Source #
Enum XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods succ :: XdgDirectoryList -> XdgDirectoryList Source # pred :: XdgDirectoryList -> XdgDirectoryList Source # toEnum :: Int -> XdgDirectoryList Source # fromEnum :: XdgDirectoryList -> Int Source # enumFrom :: XdgDirectoryList -> [XdgDirectoryList] Source # enumFromThen :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] Source # enumFromTo :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] Source # enumFromThenTo :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] Source #
Eq XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods (==) :: XdgDirectoryList -> XdgDirectoryList -> Bool # (/=) :: XdgDirectoryList -> XdgDirectoryList -> Bool #
Ord XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods compare :: XdgDirectoryList -> XdgDirectoryList -> Ordering # (<) :: XdgDirectoryList -> XdgDirectoryList -> Bool # (<=) :: XdgDirectoryList -> XdgDirectoryList -> Bool # (>) :: XdgDirectoryList -> XdgDirectoryList -> Bool # (>=) :: XdgDirectoryList -> XdgDirectoryList -> Bool # max :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList # min :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList #
Read XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods readsPrec :: Int -> ReadS XdgDirectoryList Source # readList :: ReadS [XdgDirectoryList] Source # readPrec :: ReadPrec XdgDirectoryList Source # readListPrec :: ReadPrec [XdgDirectoryList] Source #
Show XdgDirectoryList #
Instance details Defined in System.Directory.Internal.Common Methods showsPrec :: Int -> XdgDirectoryList -> ShowS Source # show :: XdgDirectoryList -> String Source # showList :: [XdgDirectoryList] -> ShowS Source #

createDirectoryInternal :: FilePath -> IO () Source #

removePathInternal :: Bool -> FilePath -> IO () Source #

renamePathInternal :: FilePath -> FilePath -> IO () Source #

simplify :: FilePath -> FilePath Source #

On POSIX, equivalent to simplifyPosix.

c_free :: Ptr a -> IO () Source #

c_PATH_MAX :: Maybe Int Source #

c_realpath :: CString -> CString -> IO CString Source #

withRealpath :: CString -> (CString -> IO a) -> IO a Source #

canonicalizePathWith :: ((FilePath -> IO FilePath) -> FilePath -> IO FilePath) -> FilePath -> IO FilePath Source #

canonicalizePathSimplify :: FilePath -> IO FilePath Source #

findExecutablesLazyInternal :: ([FilePath] -> String -> ListT IO FilePath) -> String -> ListT IO FilePath Source #

exeExtensionInternal :: String Source #

getDirectoryContentsInternal :: FilePath -> IO [FilePath] Source #

getCurrentDirectoryInternal :: IO FilePath Source #

prependCurrentDirectory :: FilePath -> IO FilePath Source #

Convert a path into an absolute path. If the given path is relative, the current directory is prepended and the path may or may not be simplified. If the path is already absolute, the path is returned unchanged. The function preserves the presence or absence of the trailing path separator.

If the path is already absolute, the operation never fails. Otherwise, the operation may throw exceptions.

Empty paths are treated as the current directory.

setCurrentDirectoryInternal :: FilePath -> IO () Source #

linkToDirectoryIsDirectory :: Bool Source #

createSymbolicLink :: Bool -> FilePath -> FilePath -> IO () Source #

readSymbolicLink :: FilePath -> IO FilePath Source #

type Metadata = FileStatus Source #

getSymbolicLinkMetadata :: FilePath -> IO Metadata Source #

getFileMetadata :: FilePath -> IO Metadata Source #

fileTypeFromMetadata :: Metadata -> FileType Source #

fileSizeFromMetadata :: Metadata -> Integer Source #

accessTimeFromMetadata :: Metadata -> UTCTime Source #