UnliftIO.Path.Directory

`UnliftIO.Directory lifted to Path.

Documentation

createDirectory :: MonadIO m => Path b Dir -> m ()

createDirectoryIfMissing :: MonadIO m => Bool -> Path b Dir -> m ()

removeDirectory :: MonadIO m => Path b Dir -> m ()

removeDirectoryRecursive :: MonadIO m => Path b Dir -> m ()

removePathForcibly :: MonadIO m => Path b t -> m ()

renameDirectory :: MonadIO m => Path b Dir -> Path b' Dir -> m ()

listDirectory :: (MonadThrow m, MonadIO m) => Path b Dir -> m ([Path Rel Dir], [Path Rel File])

getDirectoryContents :: (MonadThrow m, MonadIO m) => Path b Dir -> m ([Path Rel Dir], [Path Rel File])

getCurrentDirectory :: (MonadThrow m, MonadIO m) => m (Path Abs Dir)

setCurrentDirectory :: MonadIO m => Path Abs Dir -> m ()

withCurrentDirectory :: (MonadThrow m, MonadUnliftIO m) => Path Abs Dir -> m a -> m a

getHomeDirectory :: (MonadThrow m, MonadIO m) => m (Path Abs Dir)

getXdgDirectory :: (MonadThrow m, MonadIO m) => XdgDirectory -> Path Rel Dir -> m (Path Abs Dir)

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 map to the same directory.

Since: directory-1.2.3.0

Constructors

XdgData

For data files (e.g. images). Defaults to ~/.local/share and can be overridden by the XDG_DATA_HOME environment variable. On Windows, it is %APPDATA% (e.g. C:/Users/<user>/AppData/Roaming). Can be considered as the user-specific equivalent of /usr/share.

XdgConfig

For configuration files. Defaults to ~/.config and can be overridden by the XDG_CONFIG_HOME environment variable. On Windows, it 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). Defaults to ~/.cache and can be overridden by the XDG_CACHE_HOME environment variable. On Windows, it is %LOCALAPPDATA% (e.g. C:/Users/<user>/AppData/Local). Can be considered as the user-specific equivalent of /var/cache.

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]

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

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

getAppUserDataDirectory :: (MonadThrow m, MonadIO m) => Path Rel Dir -> m (Path Abs Dir)

getUserDocumentsDirectory :: (MonadThrow m, MonadIO m) => m (Path Abs Dir)

getTemporaryDirectory :: (MonadThrow m, MonadIO m) => m (Path Abs Dir)

removeFile :: MonadIO m => Path b File -> m ()

renameFile :: MonadIO m => Path b File -> Path b' File -> m ()

renamePath :: MonadIO m => Path b t -> Path b' t -> m ()

copyFile :: MonadIO m => Path b File -> Path b' File -> m ()

copyFileWithMetadata :: MonadIO m => Path b File -> Path b' File -> m ()

makeAbsoluteDir :: (MonadThrow m, MonadIO m) => Path Rel Dir -> m (Path Abs Dir)

makeAbsoluteFile :: (MonadThrow m, MonadIO m) => Path Rel File -> m (Path Abs File)

makeRelativeToCurrentDirectoryDir :: (MonadThrow m, MonadIO m) => Path Abs Dir -> m (Path Rel Dir)

makeRelativeToCurrentDirectoryFile :: (MonadThrow m, MonadIO m) => Path Abs File -> m (Path Rel File)

findExecutable :: (MonadThrow m, MonadIO m) => String -> m (Maybe (Path Abs File))

findExecutables :: (MonadThrow m, MonadIO m) => String -> m [Path Abs File]

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

getFileSize :: MonadIO m => Path b File -> m Integer

doesPathExist :: MonadIO m => Path b t -> m Bool

doesFileExist :: MonadIO m => Path b File -> m Bool

doesDirectoryExist :: MonadIO m => Path b Dir -> m Bool

pathIsSymbolicLink :: MonadIO m => Path b t -> m Bool

data Permissions

Instances

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

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

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 :: MonadIO m => Path b t -> m Permissions

setPermissions :: MonadIO m => Path b t -> Permissions -> m ()

copyPermissions :: MonadIO m => Path b t -> Path b' t' -> m ()

getAccessTime :: MonadIO m => Path b t -> m UTCTime

getModificationTime :: MonadIO m => Path b t -> m UTCTime

setAccessTime :: MonadIO m => Path b t -> UTCTime -> m ()

setModificationTime :: MonadIO m => Path b t -> UTCTime -> m ()