UnliftIO.Directory · unliftio-0.2.25.1

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

valuegetXdgDirectory :: MonadIO m => XdgDirectory -> FilePath -> m FilePath

#

Lifted getXdgDirectory.

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

valuegetXdgDirectoryList :: MonadIO m => XdgDirectoryList -> m [FilePath]

#

Lifted getXdgDirectoryList.

valuegetAppUserDataDirectory :: MonadIO m => FilePath -> m FilePath

#

Lifted getAppUserDataDirectory.

valuegetUserDocumentsDirectory :: MonadIO m => m FilePath

#

Lifted getUserDocumentsDirectory.

valuegetTemporaryDirectory :: MonadIO m => m FilePath

#

Lifted getTemporaryDirectory.

Actions on files

17 declarations

valueremoveFile :: MonadIO m => FilePath -> m ()

#

Lifted removeFile.

valuerenameFile :: MonadIO m => FilePath -> FilePath -> m ()

#

Lifted renameFile.

valuerenamePath :: MonadIO m => FilePath -> FilePath -> m ()

#

Lifted renamePath.

valuecopyFile :: MonadIO m => FilePath -> FilePath -> m ()

#

Lifted copyFile.

valuecopyFileWithMetadata :: MonadIO m => FilePath -> FilePath -> m ()

#

Lifted copyFileWithMetadata.

valuecanonicalizePath :: MonadIO m => FilePath -> m FilePath

#

Lifted canonicalizePath.

valuemakeAbsolute :: MonadIO m => FilePath -> m FilePath

#

Lifted makeAbsolute.

valuemakeRelativeToCurrentDirectory :: MonadIO m => FilePath -> m FilePath

#

Lifted makeRelativeToCurrentDirectory.

valuefindExecutable :: MonadIO m => String -> m (Maybe FilePath)

#

Lifted findExecutable.

valuefindExecutables :: MonadIO m => String -> m [FilePath]

#

Lifted findExecutables.

valuefindExecutablesInDirectories

:: MonadIO m
=> [FilePath]
-> String
-> m [FilePath]

#

Lifted findExecutablesInDirectories.

valuefindFile :: MonadIO m => [FilePath] -> String -> m (Maybe FilePath)

#

Lifted findFile.

valuefindFiles :: MonadIO m => [FilePath] -> String -> m [FilePath]

#

Lifted findFiles.

valuefindFileWith

:: MonadUnliftIO m
=> FilePath -> m Bool
-> [FilePath]
-> String
-> m (Maybe FilePath)

#

Unlifted findFileWith.

valuefindFilesWith

:: MonadUnliftIO m
=> FilePath -> m Bool
-> [FilePath]
-> String
-> m [FilePath]

#

Unlifted findFilesWith.

valueexeExtension :: String

#

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

valuegetFileSize :: MonadIO m => FilePath -> m Integer

#

Lifted getFileSize.

Existence tests

3 declarations

valuedoesPathExist :: MonadIO m => FilePath -> m Bool

#

Lifted doesPathExist.

valuedoesFileExist :: MonadIO m => FilePath -> m Bool

#

Lifted doesFileExist.

valuedoesDirectoryExist :: MonadIO m => FilePath -> m Bool

#

Lifted doesDirectoryExist.

Symbolic links

1 declaration

valuepathIsSymbolicLink :: MonadIO m => FilePath -> m Bool

#

Lifted pathIsSymbolicLink.

Permissions

13 declarations

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