Effectful.FileSystem · effectful-2.3.0.0

Effect

1 declaration

datadata FileSystem (a :: Type -> Type) b

#

An effect for interacting with the filesystem.

Instances2DispatchOf, StaticRep

type DispatchOf FileSystem = 'Static 'WithSideEffectsDefined in effectful-2.3.0.0 · Effectful.FileSystem.Effect
data StaticRep FileSystem
- FileSystem
Defined in effectful-2.3.0.0 · Effectful.FileSystem.Effect

Handlers

valuerunFileSystem :: IOE :> es => Eff (FileSystem ': es) a -> Eff es a

#

Run the FileSystem effect.

Actions on directories

8 declarations

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

#

Lifted createDirectory.

valuecreateDirectoryIfMissing

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

#

Lifted createDirectoryIfMissing.

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

#

Lifted removeDirectory.

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

#

Lifted removeDirectoryRecursive.

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

#

Lifted removePathForcibly.

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

#

Lifted renameDirectory.

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

#

Lifted listDirectory.

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

#

Lifted getDirectoryContents.

Current working directory

valuegetCurrentDirectory :: FileSystem :> es => Eff es FilePath

#

Lifted getCurrentDirectory.

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

#

Lifted setCurrentDirectory.

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

#

Lifted withCurrentDirectory.

Pre-defined directories

6 declarations

valuegetHomeDirectory :: FileSystem :> es => Eff es FilePath

#

Lifted getHomeDirectory.

valuegetXdgDirectory

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

#

Lifted getXdgDirectory.

valuegetXdgDirectoryList

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

#

Lifted getXdgDirectoryList.

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

#

Lifted getAppUserDataDirectory.

valuegetUserDocumentsDirectory :: FileSystem :> es => Eff es FilePath

#

Lifted getUserDocumentsDirectory.

valuegetTemporaryDirectory :: FileSystem :> es => Eff es FilePath

#

Lifted getTemporaryDirectory.

Actions on files

9 declarations

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

#

Lifted removeFile.

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

#

Lifted renameFile.

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

#

Lifted renamePath.

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

#

Lifted copyFile.

valuecopyFileWithMetadata

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

#

Lifted copyFileWithMetadata.

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

#

Lifted getFileSize.

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

#

Lifted canonicalizePath.

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

#

Lifted makeAbsolute.

valuemakeRelativeToCurrentDirectory

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

#

Lifted makeRelativeToCurrentDirectory.

Existence tests

10 declarations

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

#

Lifted doesPathExist.

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

#

Lifted doesFileExist.

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

#

Lifted doesDirectoryExist.

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

#

Lifted findExecutable.

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

#

Lifted findExecutables.

valuefindExecutablesInDirectories

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

#

Lifted findExecutablesInDirectories.

valuefindFile

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

#

Lifted findFile.

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

#

Lifted findFiles.

valuefindFileWith

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

#

Lifted findFileWith.

valuefindFilesWith

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

#

Lifted findFilesWith.

Symbolic links

5 declarations

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

#

Lifted createFileLink.

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

#

Lifted createDirectoryLink.

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

#

Lifted removeDirectoryLink.

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

#

Lifted pathIsSymbolicLink.

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

#

Lifted getSymbolicLinkTarget.

Permissions

3 declarations

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

#

Lifted getPermissions.

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

#

Lifted setPermissions.

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

#

Lifted copyPermissions.

Timestamps

4 declarations

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

#

Lifted getAccessTime.

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

#

Lifted getModificationTime.

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

#

Lifted setAccessTime.

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

#

Lifted setModificationTime.

Re-exports

0 declarations

Pre-defined directories

datadata 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.

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).

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Enum XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Eq XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Ord XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Read XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Show XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common

datadata XdgDirectoryList

#

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

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

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

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).

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Enum XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Eq XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Ord XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Read XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Show XdgDirectoryListDefined in directory-1.3.8.5 · System.Directory.Internal.Common

Existence tests

valueexeExtension :: String

#

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

Permissions

datadata Permissions

#

Instances4Eq, Ord, Read, Show

Eq PermissionsDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Ord PermissionsDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Read PermissionsDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Show PermissionsDefined in directory-1.3.8.5 · System.Directory.Internal.Common