filepather-0.5.5: Functions on System.FilePath
Safe HaskellSafe-Inferred
LanguageHaskell2010

System.FilePath.FilePather.Directory

Synopsis

Documentation

createDirectory :: Exception e => ReadFilePathT1 e IO Source #

createDirectoryIfMissing :: Exception e => Bool -> ReadFilePathT1 e IO Source #

removeDirectory :: Exception e => ReadFilePathT1 e IO Source #

removeDirectoryRecursive :: Exception e => ReadFilePathT1 e IO Source #

removePathForcibly :: Exception e => ReadFilePathT1 e IO Source #

renameDirectory :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

listDirectory :: Exception e => ReadFilePathT e IO [FilePath] Source #

getDirectoryContents :: Exception e => ReadFilePathT e IO [FilePath] Source #

getCurrentDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

setCurrentDirectory :: Exception e => ReadFilePathT e IO () Source #

getHomeDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

withCurrentDirectory :: Exception e => IO a -> ReadFilePathT e IO a Source #

getXdgDirectory :: Exception e => XdgDirectory -> ReadFilePathT e IO FilePath Source #

getAppUserDataDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

getUserDocumentsDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

getTemporaryDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

getXdgDirectoryList :: Exception e => XdgDirectoryList -> ReadFilePathT e IO [FilePath] Source #

removeFile :: Exception e => ReadFilePathT1 e IO Source #

renameFile :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

renamePath :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

copyFile :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

copyFileWithMetadata :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

getFileSize :: Exception e => ReadFilePathT e IO Integer Source #

canonicalizePath :: Exception e => ReadFilePathT e IO FilePath Source #

makeAbsolute :: Exception e => ReadFilePathT e IO FilePath Source #

makeRelativeToCurrentDirectory :: Exception e => ReadFilePathT e IO FilePath Source #

doesPathExist :: ReadFilePathT e IO Bool Source #

doesFileExist :: ReadFilePathT e IO Bool Source #

doesDirectoryExist :: ReadFilePathT e IO Bool Source #

findExecutable :: ReadFilePathT e IO (Maybe FilePath) Source #

findExecutables :: ReadFilePathT e IO [FilePath] Source #

findExecutablesInDirectories :: [FilePath] -> ReadFilePathT e IO [FilePath] Source #

findFile :: [FilePath] -> ReadFilePathT e IO (Maybe FilePath) Source #

findFiles :: [FilePath] -> ReadFilePathT e IO [FilePath] Source #

findFileWith :: ReadFilePathT () IO () -> [FilePath] -> ReadFilePathT () IO FilePath Source #

findFilesWith :: ReadFilePathT () IO () -> [FilePath] -> ReadFilePathT e' IO [FilePath] Source #

createFileLink :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

createDirectoryLink :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

removeDirectoryLink :: Exception e => ReadFilePathT1 e IO Source #

pathIsSymbolicLink :: Exception e => ReadFilePathT e IO Bool Source #

getSymbolicLinkTarget :: Exception e => ReadFilePathT e IO FilePath Source #

getPermissions :: Exception e => ReadFilePathT e IO Permissions Source #

setPermissions :: Exception e => Permissions -> ReadFilePathT1 e IO Source #

copyPermissions :: Exception e => FilePath -> ReadFilePathT1 e IO Source #

getAccessTime :: Exception e => ReadFilePathT e IO UTCTime Source #

getModificationTime :: Exception e => ReadFilePathT e IO UTCTime Source #

setAccessTime :: Exception e => UTCTime -> ReadFilePathT1 e IO Source #

setModificationTime :: Exception e => UTCTime -> ReadFilePathT1 e IO Source #

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

setOwnerSearchable :: Bool -> Permissions -> Permissions #

setOwnerExecutable :: Bool -> Permissions -> Permissions #

setOwnerWritable :: Bool -> Permissions -> Permissions #

setOwnerReadable :: Bool -> Permissions -> Permissions #

emptyPermissions :: 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

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 #

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

Since: directory-1.2.3.0

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

Since: directory-1.3.7.0

Instances

Instances details
Bounded XdgDirectory 
Instance details

Defined in System.Directory.Internal.Common

Methods

minBound :: XdgDirectory #

maxBound :: XdgDirectory #

Enum XdgDirectory 
Instance details

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] #

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

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 #

data XdgDirectoryList #

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

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

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

Since: directory-1.3.2.0

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

Instances

Instances details
Bounded XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Methods

minBound :: XdgDirectoryList #

maxBound :: XdgDirectoryList #

Enum XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Methods

succ :: XdgDirectoryList -> XdgDirectoryList #

pred :: XdgDirectoryList -> XdgDirectoryList #

toEnum :: Int -> XdgDirectoryList #

fromEnum :: XdgDirectoryList -> Int #

enumFrom :: XdgDirectoryList -> [XdgDirectoryList] #

enumFromThen :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] #

enumFromTo :: XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] #

enumFromThenTo :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList -> [XdgDirectoryList] #

Read XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Methods

readsPrec :: Int -> ReadS XdgDirectoryList #

readList :: ReadS [XdgDirectoryList] #

readPrec :: ReadPrec XdgDirectoryList #

readListPrec :: ReadPrec [XdgDirectoryList] #

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

Methods

(==) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

(/=) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

Ord XdgDirectoryList 
Instance details

Defined in System.Directory.Internal.Common

Methods

compare :: XdgDirectoryList -> XdgDirectoryList -> Ordering #

(<) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

(<=) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

(>) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

(>=) :: XdgDirectoryList -> XdgDirectoryList -> Bool #

max :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList #

min :: XdgDirectoryList -> XdgDirectoryList -> XdgDirectoryList #