Effectful.FileSystem

Effect

data FileSystem :: Effect

An effect for interacting with the filesystem.

Instances

type DispatchOf FileSystem

Defined in Effectful.FileSystem.Effect

type DispatchOf FileSystem = 'Static 'WithSideEffects

data StaticRep FileSystem

Defined in Effectful.FileSystem.Effect

data StaticRep FileSystem = FileSystem

Handlers

runFileSystem :: (HasCallStack, IOE :> es) => Eff (FileSystem : es) a -> Eff es a

Run the FileSystem effect.

Actions on directories

createDirectory :: FileSystem :> es => FilePath -> Eff es ()

Lifted createDirectory.

createDirectoryIfMissing :: FileSystem :> es => Bool -> FilePath -> Eff es ()

Lifted createDirectoryIfMissing.

removeDirectory :: FileSystem :> es => FilePath -> Eff es ()

Lifted removeDirectory.

removeDirectoryRecursive :: FileSystem :> es => FilePath -> Eff es ()

Lifted removeDirectoryRecursive.

removePathForcibly :: FileSystem :> es => FilePath -> Eff es ()

Lifted removePathForcibly.

renameDirectory :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted renameDirectory.

listDirectory :: FileSystem :> es => FilePath -> Eff es [FilePath]

Lifted listDirectory.

getDirectoryContents :: FileSystem :> es => FilePath -> Eff es [FilePath]

Lifted getDirectoryContents.

Current working directory

getCurrentDirectory :: FileSystem :> es => Eff es FilePath

Lifted getCurrentDirectory.

setCurrentDirectory :: FileSystem :> es => FilePath -> Eff es ()

Lifted setCurrentDirectory.

withCurrentDirectory :: FileSystem :> es => FilePath -> Eff es a -> Eff es a

Lifted withCurrentDirectory.

Pre-defined directories

getHomeDirectory :: FileSystem :> es => Eff es FilePath

Lifted getHomeDirectory.

getXdgDirectory :: FileSystem :> es => XdgDirectory -> FilePath -> Eff es FilePath

Lifted getXdgDirectory.

getXdgDirectoryList :: FileSystem :> es => XdgDirectoryList -> Eff es [FilePath]

Lifted getXdgDirectoryList.

getAppUserDataDirectory :: FileSystem :> es => FilePath -> Eff es FilePath

Lifted getAppUserDataDirectory.

getUserDocumentsDirectory :: FileSystem :> es => Eff es FilePath

Lifted getUserDocumentsDirectory.

getTemporaryDirectory :: FileSystem :> es => Eff es FilePath

Lifted getTemporaryDirectory.

Actions on files

removeFile :: FileSystem :> es => FilePath -> Eff es ()

Lifted removeFile.

renameFile :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted renameFile.

renamePath :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted renamePath.

copyFile :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted copyFile.

copyFileWithMetadata :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted copyFileWithMetadata.

getFileSize :: FileSystem :> es => FilePath -> Eff es Integer

Lifted getFileSize.

canonicalizePath :: FileSystem :> es => FilePath -> Eff es FilePath

Lifted canonicalizePath.

makeAbsolute :: FileSystem :> es => FilePath -> Eff es FilePath

Lifted makeAbsolute.

makeRelativeToCurrentDirectory :: FileSystem :> es => FilePath -> Eff es FilePath

Lifted makeRelativeToCurrentDirectory.

Existence tests

doesPathExist :: FileSystem :> es => FilePath -> Eff es Bool

Lifted doesPathExist.

doesFileExist :: FileSystem :> es => FilePath -> Eff es Bool

Lifted doesFileExist.

doesDirectoryExist :: FileSystem :> es => FilePath -> Eff es Bool

Lifted doesDirectoryExist.

findExecutable :: FileSystem :> es => String -> Eff es (Maybe FilePath)

Lifted findExecutable.

findExecutables :: FileSystem :> es => String -> Eff es [FilePath]

Lifted findExecutables.

findExecutablesInDirectories :: FileSystem :> es => [FilePath] -> String -> Eff es [FilePath]

Lifted findExecutablesInDirectories.

findFile :: FileSystem :> es => [FilePath] -> String -> Eff es (Maybe FilePath)

Lifted findFile.

findFiles :: FileSystem :> es => [FilePath] -> String -> Eff es [FilePath]

Lifted findFiles.

findFileWith :: FileSystem :> es => (FilePath -> Eff es Bool) -> [FilePath] -> String -> Eff es (Maybe FilePath)

Lifted findFileWith.

findFilesWith :: FileSystem :> es => (FilePath -> Eff es Bool) -> [FilePath] -> String -> Eff es [FilePath]

Lifted findFilesWith.

Symbolic links

createFileLink :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted createFileLink.

createDirectoryLink :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted createDirectoryLink.

removeDirectoryLink :: FileSystem :> es => FilePath -> Eff es ()

Lifted removeDirectoryLink.

pathIsSymbolicLink :: FileSystem :> es => FilePath -> Eff es Bool

Lifted pathIsSymbolicLink.

getSymbolicLinkTarget :: FileSystem :> es => FilePath -> Eff es FilePath

Lifted getSymbolicLinkTarget.

Permissions

getPermissions :: FileSystem :> es => FilePath -> Eff es Permissions

Lifted getPermissions.

setPermissions :: FileSystem :> es => FilePath -> Permissions -> Eff es ()

Lifted setPermissions.

copyPermissions :: FileSystem :> es => FilePath -> FilePath -> Eff es ()

Lifted copyPermissions.

Timestamps

getAccessTime :: FileSystem :> es => FilePath -> Eff es UTCTime

Lifted getAccessTime.

getModificationTime :: FileSystem :> es => FilePath -> Eff es UTCTime

Lifted getModificationTime.

setAccessTime :: FileSystem :> es => FilePath -> UTCTime -> Eff es ()

Lifted setAccessTime.

setModificationTime :: FileSystem :> es => FilePath -> UTCTime -> Eff es ()

Lifted setModificationTime.

Re-exports

Pre-defined directories

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

Existence tests

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

Permissions

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