HaskellWorks.Polysemy.System.Directory

Documentation

data XdgDirectory

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.

XdgState

For data that should persist between (application) restarts, but that is not important or portable enough to the user that it should be stored in XdgData. It uses the XDG_STATE_HOME environment variable. On non-Windows sytems, the default is ~/.local/state. On Windows, the default is %LOCALAPPDATA% (e.g. C:/Users/<user>/AppData/Local).

Since: directory-1.3.7.0

Instances

Bounded XdgDirectory

Defined in System.Directory.Internal.Common

Methods

minBound :: XdgDirectory

maxBound :: XdgDirectory

Enum XdgDirectory

Defined in System.Directory.Internal.Common

Methods

succ :: XdgDirectory -> XdgDirectory

pred :: XdgDirectory -> XdgDirectory

toEnum :: Int -> XdgDirectory

fromEnum :: XdgDirectory -> Int

enumFrom :: XdgDirectory -> [XdgDirectory]

enumFromThen :: XdgDirectory -> XdgDirectory -> [XdgDirectory]

enumFromTo :: XdgDirectory -> XdgDirectory -> [XdgDirectory]

enumFromThenTo :: XdgDirectory -> XdgDirectory -> XdgDirectory -> [XdgDirectory]

Read XdgDirectory

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS XdgDirectory

readList :: ReadS [XdgDirectory]

readPrec :: ReadPrec XdgDirectory

readListPrec :: ReadPrec [XdgDirectory]

Show XdgDirectory

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> XdgDirectory -> ShowS

show :: XdgDirectory -> String

showList :: [XdgDirectory] -> ShowS

Eq XdgDirectory

Defined in System.Directory.Internal.Common

Methods

(==) :: XdgDirectory -> XdgDirectory -> Bool

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

Ord XdgDirectory

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

data XdgDirectoryList

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

Bounded XdgDirectoryList

Defined in System.Directory.Internal.Common

Methods

minBound :: XdgDirectoryList

maxBound :: XdgDirectoryList

Enum XdgDirectoryList

Defined in System.Directory.Internal.Common

Methods

succ :: XdgDirectoryList -> XdgDirectoryList

pred :: XdgDirectoryList -> XdgDirectoryList

toEnum :: Int -> XdgDirectoryList

fromEnum :: XdgDirectoryList -> Int

enumFrom :: XdgDirectoryList -> [XdgDirectoryList]

enumFromThen :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList]

enumFromTo :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList]

enumFromThenTo :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList]

Read XdgDirectoryList

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS XdgDirectoryList

readList :: ReadS [XdgDirectoryList]

readPrec :: ReadPrec XdgDirectoryList

readListPrec :: ReadPrec [XdgDirectoryList]

Show XdgDirectoryList

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> XdgDirectoryList -> ShowS

show :: XdgDirectoryList -> String

showList :: [XdgDirectoryList] -> ShowS

Eq XdgDirectoryList

Defined in System.Directory.Internal.Common

Methods

(==) :: XdgDirectoryList -> XdgDirectoryList -> Bool

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

Ord XdgDirectoryList

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

Actions on directories

createDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

createDirectoryIfMissing :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => Bool -> FilePath -> Sem r ()

removeDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

removeDirectoryRecursive :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

removePathForcibly :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

renameDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

listDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r [FilePath]

getDirectoryContents :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r [FilePath]

Current working directory

getCurrentDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => Sem r FilePath

setCurrentDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

withCurrentDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Resource r => Member Log r => FilePath -> Sem r () -> Sem r ()

Pre-defined directories

getHomeDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => Sem r FilePath

getXdgDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => XdgDirectory -> FilePath -> Sem r FilePath

getXdgDirectoryList :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => XdgDirectoryList -> Sem r [FilePath]

getAppUserDataDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

getUserDocumentsDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => Sem r FilePath

getTemporaryDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => Sem r FilePath

Actions on files

removeFile :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

renameFile :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

renamePath :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

copyFile :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

copyFileWithMetadata :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

getFileSize :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Integer

canonicalizePath :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

makeAbsolute :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

makeRelativeToCurrentDirectory :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

Existence tests

doesPathExist :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Bool

doesFileExist :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Bool

doesDirectoryExist :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Bool

findExecutable :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => String -> Sem r (Maybe FilePath)

findExecutables :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => String -> Sem r [FilePath]

findExecutablesInDirectories :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => [FilePath] -> String -> Sem r [FilePath]

findFile :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => [FilePath] -> String -> Sem r (Maybe FilePath)

findFiles :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => [FilePath] -> String -> Sem r [FilePath]

findFileWith :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => (FilePath -> IO Bool) -> [FilePath] -> String -> Sem r (Maybe FilePath)

findFilesWith :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => (FilePath -> IO Bool) -> [FilePath] -> String -> Sem r [FilePath]

exeExtension :: String

Filename extension for executable files (including the dot if any) (usually "" on POSIX systems and ".exe" on Windows or OS/2).

Since: directory-1.2.4.0

Symbolic links

createFileLink :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

createDirectoryLink :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

removeDirectoryLink :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r ()

pathIsSymbolicLink :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Bool

getSymbolicLinkTarget :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

data Permissions

Instances

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

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

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

getPermissions :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Permissions

setPermissions :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Permissions -> Sem r ()

copyPermissions :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> FilePath -> Sem r ()

Timestamps

getAccessTime :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r UTCTime

getModificationTime :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r UTCTime

setAccessTime :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> UTCTime -> Sem r ()

setModificationTime :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> UTCTime -> Sem r ()