unliftio-0.2.25.0: The MonadUnliftIO typeclass for unlifting monads to IO (batteries included)
Safe HaskellNone
LanguageHaskell2010

UnliftIO.Directory

Description

Unlifted System.Directory.

Since: 0.2.6.0

Synopsis

Actions on directories

createDirectory :: MonadIO m => FilePath -> m () Source #

Lifted createDirectory.

Since: 0.2.6.0

createDirectoryIfMissing :: MonadIO m => Bool -> FilePath -> m () Source #

Lifted createDirectoryIfMissing.

Since: 0.2.6.0

createFileLink Source #

Arguments

:: MonadIO m 
=> FilePath

path to the target file

-> FilePath

path of the link to be created

-> m () 

Lifted createFileLink. directory package version should be >= 1.3.1. @since 0.2.16.0

createDirectoryLink :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted createDirectoryLink.

Since: 0.2.21.0

removeDirectoryLink :: MonadIO m => FilePath -> m () Source #

Lifted removeDirectoryLink.

Since: 0.2.21.0

getSymbolicLinkTarget :: MonadIO m => FilePath -> m FilePath Source #

Lifted getSymbolicLinkTarget.

Since: 0.2.21.0

removeDirectory :: MonadIO m => FilePath -> m () Source #

Lifted removeDirectory.

Since: 0.2.6.0

removeDirectoryRecursive :: MonadIO m => FilePath -> m () Source #

Lifted removeDirectoryRecursive.

Since: 0.2.6.0

removePathForcibly :: MonadIO m => FilePath -> m () Source #

Lifted removePathForcibly.

Since: 0.2.6.0

renameDirectory :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted renameDirectory.

Since: 0.2.6.0

listDirectory :: MonadIO m => FilePath -> m [FilePath] Source #

Lifted listDirectory.

Since: 0.2.6.0

getDirectoryContents :: MonadIO m => FilePath -> m [FilePath] Source #

Lifted getDirectoryContents.

Since: 0.2.6.0

Current working directory

getCurrentDirectory :: MonadIO m => m FilePath Source #

Lifted getCurrentDirectory.

Since: 0.2.6.0

setCurrentDirectory :: MonadIO m => FilePath -> m () Source #

Lifted setCurrentDirectory.

Since: 0.2.6.0

withCurrentDirectory :: MonadUnliftIO m => FilePath -> m a -> m a Source #

Unlifted withCurrentDirectory.

Since: 0.2.6.0

Pre-defined directories

getHomeDirectory :: MonadIO m => m FilePath Source #

Lifted getHomeDirectory.

Since: 0.2.6.0

data XdgDirectory #

Instances

Instances details
Bounded XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Enum XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Read XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS XdgDirectory

readList :: ReadS [XdgDirectory]

readPrec :: ReadPrec XdgDirectory

readListPrec :: ReadPrec [XdgDirectory]

Show XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> XdgDirectory -> ShowS

show :: XdgDirectory -> String

showList :: [XdgDirectory] -> ShowS

Eq XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Methods

(==) :: XdgDirectory -> XdgDirectory -> Bool

(/=) :: XdgDirectory -> XdgDirectory -> Bool

Ord XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

getXdgDirectory :: MonadIO m => XdgDirectory -> FilePath -> m FilePath Source #

Lifted getXdgDirectory.

Since: 0.2.6.0

data XdgDirectoryList #

Constructors

XdgDataDirs 
XdgConfigDirs 

Instances

Instances details
Bounded XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Enum XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Read XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Show XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> XdgDirectoryList -> ShowS

show :: XdgDirectoryList -> String

showList :: [XdgDirectoryList] -> ShowS

Eq XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Ord XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

getXdgDirectoryList :: MonadIO m => XdgDirectoryList -> m [FilePath] Source #

Lifted getXdgDirectoryList.

Since: 0.2.21.0

getAppUserDataDirectory :: MonadIO m => FilePath -> m FilePath Source #

Lifted getAppUserDataDirectory.

Since: 0.2.6.0

getUserDocumentsDirectory :: MonadIO m => m FilePath Source #

Lifted getUserDocumentsDirectory.

Since: 0.2.6.0

getTemporaryDirectory :: MonadIO m => m FilePath Source #

Lifted getTemporaryDirectory.

Since: 0.2.6.0

Actions on files

removeFile :: MonadIO m => FilePath -> m () Source #

Lifted removeFile.

Since: 0.2.6.0

renameFile :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted renameFile.

Since: 0.2.6.0

renamePath :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted renamePath.

Since: 0.2.6.0

copyFile :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted copyFile.

Since: 0.2.6.0

copyFileWithMetadata :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted copyFileWithMetadata.

Since: 0.2.6.0

canonicalizePath :: MonadIO m => FilePath -> m FilePath Source #

Lifted canonicalizePath.

Since: 0.2.6.0

makeAbsolute :: MonadIO m => FilePath -> m FilePath Source #

Lifted makeAbsolute.

Since: 0.2.6.0

makeRelativeToCurrentDirectory :: MonadIO m => FilePath -> m FilePath Source #

Lifted makeRelativeToCurrentDirectory.

Since: 0.2.6.0

findExecutable :: MonadIO m => String -> m (Maybe FilePath) Source #

Lifted findExecutable.

Since: 0.2.6.0

findExecutables :: MonadIO m => String -> m [FilePath] Source #

Lifted findExecutables.

Since: 0.2.6.0

findExecutablesInDirectories :: MonadIO m => [FilePath] -> String -> m [FilePath] Source #

Lifted findExecutablesInDirectories.

Since: 0.2.6.0

findFile :: MonadIO m => [FilePath] -> String -> m (Maybe FilePath) Source #

Lifted findFile.

Since: 0.2.6.0

findFiles :: MonadIO m => [FilePath] -> String -> m [FilePath] Source #

Lifted findFiles.

Since: 0.2.6.0

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

Unlifted findFileWith.

Since: 0.2.6.0

findFilesWith :: MonadUnliftIO m => (FilePath -> m Bool) -> [FilePath] -> String -> m [FilePath] Source #

Unlifted findFilesWith.

Since: 0.2.6.0

exeExtension :: String #

getFileSize :: MonadIO m => FilePath -> m Integer Source #

Lifted getFileSize.

Since: 0.2.6.0

Existence tests

doesPathExist :: MonadIO m => FilePath -> m Bool Source #

Lifted doesPathExist.

Since: 0.2.6.0

doesFileExist :: MonadIO m => FilePath -> m Bool Source #

Lifted doesFileExist.

Since: 0.2.6.0

doesDirectoryExist :: MonadIO m => FilePath -> m Bool Source #

Lifted doesDirectoryExist.

Since: 0.2.6.0

Symbolic links

pathIsSymbolicLink :: MonadIO m => FilePath -> m Bool Source #

Lifted pathIsSymbolicLink.

Since: 0.2.6.0

Permissions

data Permissions #

Instances

Instances details
Read Permissions 
Instance details

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS Permissions

readList :: ReadS [Permissions]

readPrec :: ReadPrec Permissions

readListPrec :: ReadPrec [Permissions]

Show Permissions 
Instance details

Defined in System.Directory.Internal.Common

Methods

showsPrec :: Int -> Permissions -> ShowS

show :: Permissions -> String

showList :: [Permissions] -> ShowS

Eq Permissions 
Instance details

Defined in System.Directory.Internal.Common

Methods

(==) :: Permissions -> Permissions -> Bool

(/=) :: Permissions -> Permissions -> Bool

Ord Permissions 
Instance details

Defined in System.Directory.Internal.Common

getPermissions :: MonadIO m => FilePath -> m Permissions Source #

Lifted getPermissions.

Since: 0.2.6.0

setPermissions :: MonadIO m => FilePath -> Permissions -> m () Source #

Lifted setPermissions.

Since: 0.2.6.0

copyPermissions :: MonadIO m => FilePath -> FilePath -> m () Source #

Lifted copyPermissions.

Since: 0.2.6.0

Timestamps

getAccessTime :: MonadIO m => FilePath -> m UTCTime Source #

Lifted getAccessTime.

Since: 0.2.6.0

getModificationTime :: MonadIO m => FilePath -> m UTCTime Source #

Lifted getModificationTime.

Since: 0.2.6.0

setAccessTime :: MonadIO m => FilePath -> UTCTime -> m () Source #

Lifted setAccessTime.

Since: 0.2.6.0

setModificationTime :: MonadIO m => FilePath -> UTCTime -> m () Source #

Lifted setModificationTime.

Since: 0.2.6.0