| Stability | unstable |
|---|---|
| Portability | unportable |
| Safe Haskell | None |
| Language | Haskell2010 |
System.Directory.Internal
Description
Internal modules are always subject to change from version to version. The contents of this module are also platform-dependent, hence what is shown in the Hackage documentation may differ from what is actually available on your system.
Synopsis
- data FileType
- os :: String -> OsString
- data OsString
- type OsPath = OsString
- data XdgDirectory
- data XdgDirectoryList
- data Permissions = Permissions {
- readable :: Bool
- writable :: Bool
- executable :: Bool
- searchable :: Bool
- newtype ListT (m :: Type -> Type) a = ListT {}
- emptyListT :: forall (m :: Type -> Type) a. Applicative m => ListT m a
- maybeToListT :: Applicative m => m (Maybe a) -> ListT m a
- listToListT :: forall (m :: Type -> Type) a. Applicative m => [a] -> ListT m a
- liftJoinListT :: Monad m => m (ListT m a) -> ListT m a
- listTHead :: Functor m => ListT m a -> m (Maybe a)
- listTToList :: Monad m => ListT m a -> m [a]
- andM :: Monad m => m Bool -> m Bool -> m Bool
- sequenceWithIOErrors_ :: [IO ()] -> IO ()
- tryIOErrorType :: (IOError -> Bool) -> IO a -> IO (Either IOError a)
- ignoreIOExceptions :: IO () -> IO ()
- specializeErrorString :: String -> (IOError -> Bool) -> IO a -> IO a
- ioeAddLocation :: IOError -> String -> IOError
- rightOrError :: Exception e => Either e a -> a
- so :: OsString -> String
- ioeSetOsPath :: IOError -> OsPath -> IOError
- expandDots :: [OsPath] -> [OsPath]
- normalisePathSeps :: OsPath -> OsPath
- normaliseTrailingSep :: OsPath -> OsPath
- emptyToCurDir :: OsPath -> OsPath
- simplifyPosix :: OsPath -> OsPath
- simplifyWindows :: OsPath -> OsPath
- fileTypeIsDirectory :: FileType -> Bool
- fileTypeIsLink :: FileType -> Bool
- withBinaryHandle :: IO Handle -> (Handle -> IO r) -> IO r
- copyHandleData :: Handle -> Handle -> IO ()
- readSymbolicLink :: OsPath -> IO OsPath
- setFileMode :: OsPath -> Mode -> IO ()
- createSymbolicLink :: Bool -> OsPath -> OsPath -> IO ()
- createDirectoryInternal :: OsPath -> IO ()
- removePathInternal :: Bool -> OsPath -> IO ()
- renamePathInternal :: OsPath -> OsPath -> IO ()
- filesAlwaysRemovable :: Bool
- simplify :: OsPath -> OsPath
- c_free :: Ptr a -> IO ()
- c_PATH_MAX :: Maybe Int
- c_realpath :: CString -> CString -> IO CString
- withRealpath :: CString -> (CString -> IO a) -> IO a
- canonicalizePathWith :: ((OsPath -> IO OsPath) -> OsPath -> IO OsPath) -> OsPath -> IO OsPath
- canonicalizePathSimplify :: OsPath -> IO OsPath
- findExecutablesLazyInternal :: ([OsPath] -> OsString -> ListT IO OsPath) -> OsString -> ListT IO OsPath
- getPath :: IO [OsPath]
- exeExtensionInternal :: OsString
- getDirectoryContentsInternal :: OsPath -> IO [OsPath]
- getCurrentDirectoryInternal :: IO OsPath
- prependCurrentDirectory :: OsPath -> IO OsPath
- setCurrentDirectoryInternal :: OsPath -> IO ()
- linkToDirectoryIsDirectory :: Bool
- createHardLink :: OsPath -> OsPath -> IO ()
- type Metadata = FileStatus
- getSymbolicLinkMetadata :: OsPath -> IO Metadata
- getFileMetadata :: OsPath -> IO Metadata
- fileTypeFromMetadata :: Metadata -> FileType
- fileSizeFromMetadata :: Metadata -> Integer
- accessTimeFromMetadata :: Metadata -> UTCTime
- modificationTimeFromMetadata :: Metadata -> UTCTime
- type Mode = FileMode
- modeFromMetadata :: Metadata -> Mode
- allWriteMode :: FileMode
- hasWriteMode :: Mode -> Bool
- setWriteMode :: Bool -> Mode -> Mode
- setFilePermissions :: OsPath -> Mode -> IO ()
- getAccessPermissions :: OsPath -> IO Permissions
- setAccessPermissions :: OsPath -> Permissions -> IO ()
- copyOwnerFromStatus :: FileStatus -> OsPath -> IO ()
- copyGroupFromStatus :: FileStatus -> OsPath -> IO ()
- tryCopyOwnerAndGroupFromStatus :: FileStatus -> OsPath -> IO ()
- defaultFlags :: OpenFileFlags
- openFileForRead :: OsPath -> IO Handle
- openFileForWrite :: OsPath -> IO Handle
- copyFileContents :: OsPath -> OsPath -> IO ()
- copyFileWithMetadataInternal :: (Metadata -> OsPath -> IO ()) -> (Metadata -> OsPath -> IO ()) -> OsPath -> OsPath -> IO ()
- setTimes :: OsPath -> (Maybe POSIXTime, Maybe POSIXTime) -> IO ()
- lookupEnvOs :: OsString -> IO (Maybe OsString)
- getEnvOs :: OsString -> IO OsString
- getHomeDirectoryInternal :: IO OsPath
- getXdgDirectoryFallback :: IO OsPath -> XdgDirectory -> IO OsPath
- getXdgDirectoryListFallback :: XdgDirectoryList -> IO [OsPath]
- getAppUserDataDirectoryInternal :: OsPath -> IO OsPath
- getUserDocumentsDirectoryInternal :: IO OsPath
- getTemporaryDirectoryInternal :: IO OsPath
Documentation
Constructors
| File | |
| SymbolicLink | POSIX: either file or directory link; Windows: file link |
| Directory | |
| DirectoryLink | Windows only: directory link |
Instances
| Bounded FileType Source # | |
| Enum FileType Source # | |
Defined in System.Directory.Internal.Common Methods succ :: FileType -> FileType Source # pred :: FileType -> FileType Source # toEnum :: Int -> FileType Source # fromEnum :: FileType -> Int Source # enumFrom :: FileType -> [FileType] Source # enumFromThen :: FileType -> FileType -> [FileType] Source # enumFromTo :: FileType -> FileType -> [FileType] Source # enumFromThenTo :: FileType -> FileType -> FileType -> [FileType] Source # | |
| Read FileType Source # | |
| Show FileType Source # | |
| Eq FileType Source # | |
| Ord FileType Source # | |
Defined in System.Directory.Internal.Common | |
os :: String -> OsString Source #
Fallibly converts String to OsString. Only intended to be used on literals.
Newtype representing short operating system specific strings.
Internally this is either WindowsString or PosixString,
depending on the platform. Both use unpinned
ShortByteString for efficiency.
The constructor is only exported via System.OsString.Internal.Types, since dealing with the internals isn't generally recommended, but supported in case you need to write platform specific code.
Instances
| Monoid OsString | "String-Concatenation" for | ||||
| Semigroup OsString | |||||
| Generic OsString | |||||
Defined in System.OsString.Internal.Types.Hidden Associated Types
| |||||
| Show OsString | On windows, decodes as UCS-2. On unix prints the raw bytes without decoding. | ||||
| NFData OsString | |||||
Defined in System.OsString.Internal.Types.Hidden | |||||
| Eq OsString | Byte equality of the internal representation. | ||||
| Ord OsString | Byte ordering of the internal representation. | ||||
Defined in System.OsString.Internal.Types.Hidden | |||||
| Lift OsString | |||||
| type Rep OsString | |||||
Defined in System.OsString.Internal.Types.Hidden type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1-c404" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString))) | |||||
type OsPath = OsString Source #
Type representing filenames/pathnames.
This type doesn't add any guarantees over OsString.
data 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.
Since: directory-1.2.3.0
Constructors
| XdgData | For data files (e.g. images).
It uses the |
| XdgConfig | For configuration files.
It uses the |
| XdgCache | For non-essential files (e.g. cache).
It uses the |
| 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 Since: directory-1.3.7.0 |
Instances
data XdgDirectoryList Source #
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 |
| XdgConfigDirs | For configuration files.
It uses the |
Instances
data Permissions Source #
Constructors
| Permissions | |
Fields
| |
Instances
| Read Permissions Source # | |
Defined in System.Directory.Internal.Common | |
| Show Permissions Source # | |
Defined in System.Directory.Internal.Common | |
| Eq Permissions Source # | |
Defined in System.Directory.Internal.Common | |
| Ord Permissions Source # | |
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 # | |
emptyListT :: forall (m :: Type -> Type) a. Applicative m => ListT m a Source #
maybeToListT :: Applicative m => m (Maybe a) -> ListT m a Source #
listToListT :: forall (m :: Type -> Type) a. Applicative m => [a] -> ListT m a Source #
listTToList :: Monad m => ListT m a -> m [a] Source #
sequenceWithIOErrors_ :: [IO ()] -> IO () Source #
ignoreIOExceptions :: IO () -> IO () Source #
Attempt to perform the given action, silencing any IO exception thrown by it.
rightOrError :: Exception e => Either e a -> a Source #
so :: OsString -> String Source #
Fallibly converts OsString to String. Only intended to be used on literals.
expandDots :: [OsPath] -> [OsPath] Source #
Given a list of path segments, expand . and ... The path segments
must not contain path separators.
normalisePathSeps :: OsPath -> OsPath Source #
Convert to the right kind of slashes.
normaliseTrailingSep :: OsPath -> OsPath Source #
Remove redundant trailing slashes and pick the right kind of slash.
emptyToCurDir :: OsPath -> OsPath Source #
Convert empty paths to the current directory, otherwise leave it unchanged.
simplifyWindows :: OsPath -> OsPath Source #
fileTypeIsDirectory :: FileType -> Bool Source #
Check whether the given FileType is considered a directory by the
operating system. This affects the choice of certain functions
e.g. removeDirectory vs removeFile.
Copy data from one handle to another until end of file.
createDirectoryInternal :: OsPath -> IO () Source #
c_PATH_MAX :: Maybe Int Source #
canonicalizePathWith :: ((OsPath -> IO OsPath) -> OsPath -> IO OsPath) -> OsPath -> IO OsPath Source #
findExecutablesLazyInternal :: ([OsPath] -> OsString -> ListT IO OsPath) -> OsString -> ListT IO OsPath Source #
prependCurrentDirectory :: OsPath -> IO OsPath Source #
Convert a path into an absolute path. If the given path is relative, the current directory is prepended and the path may or may not be simplified. If the path is already absolute, the path is returned unchanged. The function preserves the presence or absence of the trailing path separator.
If the path is already absolute, the operation never fails. Otherwise, the operation may throw exceptions.
Empty paths are treated as the current directory.
setCurrentDirectoryInternal :: OsPath -> IO () Source #
type Metadata = FileStatus Source #
modeFromMetadata :: Metadata -> Mode Source #
hasWriteMode :: Mode -> Bool Source #
setAccessPermissions :: OsPath -> Permissions -> IO () Source #
copyOwnerFromStatus :: FileStatus -> OsPath -> IO () Source #
copyGroupFromStatus :: FileStatus -> OsPath -> IO () Source #
tryCopyOwnerAndGroupFromStatus :: FileStatus -> OsPath -> IO () Source #
Truncate the destination file and then copy the contents of the source file to the destination file. If the destination file already exists, its attributes shall remain unchanged. Otherwise, its attributes are reset to the defaults.
copyFileWithMetadataInternal :: (Metadata -> OsPath -> IO ()) -> (Metadata -> OsPath -> IO ()) -> OsPath -> OsPath -> IO () Source #
getHomeDirectoryInternal :: IO OsPath Source #
$HOME is preferred, because the user has control over it. However, POSIX
doesn't define it as a mandatory variable, so fall back to getpwuid_r.
getXdgDirectoryFallback :: IO OsPath -> XdgDirectory -> IO OsPath Source #