HORIZON HASKELLDocslts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K
Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Moduleeffectful-2.7.1.0GHC2021

Effectful.FileSystem

Contents
  1. Effect
  2. Handlers
  3. Actions on directories
  4. Current working directory
  5. Pre-defined directories
  6. Actions on files
  7. Existence tests
  8. Symbolic links
  9. Permissions
  10. Timestamps
  11. Re-exports
  12. Pre-defined directories
  13. Existence tests
  14. Permissions
Synopsis

Effect

Handlers

Actions on directories

Current working directory

Pre-defined directories

Actions on files

Existence tests

Symbolic links

Permissions

Timestamps

Re-exports

Pre-defined directories

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

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 systems, 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.11.0 · System.Directory.Internal.Common
  • Enum XdgDirectoryDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Eq XdgDirectoryDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Ord XdgDirectoryDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Read XdgDirectoryDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Show XdgDirectoryDefined in directory-1.3.11.0 · System.Directory.Internal.Common
datadata XdgDirectoryList
Source#

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

Existence tests

valueexeExtension :: String
Source#

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.11.0 · System.Directory.Internal.Common
  • Ord PermissionsDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Read PermissionsDefined in directory-1.3.11.0 · System.Directory.Internal.Common
  • Show PermissionsDefined in directory-1.3.11.0 · System.Directory.Internal.Common