System.Directory.Internal · directory-1.3.10.0

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.

valuefileTypeIsLink :: FileType -> Bool

#

Return whether the given FileType is a link.

valueignoreIOExceptions :: IO () -> IO ()

#

Attempt to perform the given action, silencing any IO exception thrown by it.

valueioeAddLocation :: IOError -> String -> IOError

#

valueioeSetOsPath :: IOError -> OsPath -> IOError

#

valueisNoFollow :: WhetherFollow -> Bool

#

valueliftJoinListT :: Monad m => m (ListT m a) -> ListT m a

#

valuelistTHead :: Functor m => ListT m a -> m (Maybe a)

#

valuelistTToList :: Monad m => ListT m a -> m [a]

#

valuelistToListT :: Applicative m => [a] -> ListT m a

#

valuemaybeToListT :: Applicative m => m (Maybe a) -> ListT m a

#

valuenormalisePathSeps :: OsPath -> OsPath

#

Convert to the right kind of slashes.

valuenormaliseTrailingSep :: OsPath -> OsPath

#

Remove redundant trailing slashes and pick the right kind of slash.

valueos :: String -> OsString

#

Fallibly converts String to OsString. Only intended to be used on literals.

valuerightOrError :: Exception e => Either e a -> a

#

valuesequenceWithIOErrors_ :: [IO ()] -> IO ()

#

valuesimplifyPosix :: OsPath -> OsPath

#

Similar to normalise but empty paths stay empty.

valuesimplifyWindows :: OsPath -> OsPath

#

Similar to normalise but:

empty paths stay empty,
parent dirs (..) are expanded, and
paths starting with \\?\ are preserved.

The goal is to preserve the meaning of paths better than normalise.

valueso :: OsString -> String

#

Fallibly converts OsString to String. Only intended to be used on literals.

valuespecializeErrorString :: String -> (IOError -> Bool) -> IO a -> IO a

#

valuetryIOErrorType :: (IOError -> Bool) -> IO a -> IO (Either IOError a)

#

Similar to try but only catches a specify kind of IOError as specified by the predicate.

valuewithBinaryFile :: OsPath -> IOMode -> (Handle -> IO r) -> IO r

#

datadata FileType

#

Constructors

File
SymbolicLink
POSIX: either file or directory link; Windows: file link
Directory
DirectoryLink
Windows only: directory link

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Enum FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Eq FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Ord FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Read FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Show FileTypeDefined in directory-1.3.10.0 · System.Directory.Internal.Common

newtypenewtype ListT (m :: Type -> Type) a

#

A generator with side-effects.

Constructors

ListT
- unListT :: m (Maybe (a, ListT m a))

datadata Permissions

#

Constructors

Permissions
- readable :: Bool
- writable :: Bool
- executable :: Bool
- searchable :: Bool

Instances4Eq, Ord, Read, Show

Eq PermissionsDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Ord PermissionsDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Read PermissionsDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Show PermissionsDefined in directory-1.3.10.0 · System.Directory.Internal.Common

datadata WhetherFollow

#

NoFollow FollowLinks

Instances1Show

Show WhetherFollowDefined in directory-1.3.10.0 · System.Directory.Internal.Common

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

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

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Enum XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Eq XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Ord XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Read XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Show XdgDirectoryDefined in directory-1.3.10.0 · System.Directory.Internal.Common

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.10.0 · System.Directory.Internal.Common
Enum XdgDirectoryListDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Eq XdgDirectoryListDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Ord XdgDirectoryListDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Read XdgDirectoryListDefined in directory-1.3.10.0 · System.Directory.Internal.Common
Show XdgDirectoryListDefined in directory-1.3.10.0 · System.Directory.Internal.Common

typetype OsPath = OsString

#

Type representing filenames/pathnames.

This type doesn't add any guarantees over OsString.

newtypenewtype OsString

#

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.

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
Byte equality of the internal representation.
Ord OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
Byte ordering of the internal representation.
Show OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
On windows, decodes as UCS-2. On unix prints the raw bytes without decoding.
Generic OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
Semigroup OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
Monoid OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
"String-Concatenation" for OsString. This is not the same as (</>).
NFData OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
Lift OsStringDefined in os-string-2.0.8 · System.OsString.Internal.Types
type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types" "os-string-2.0.8-7fdb" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString)))Defined in os-string-2.0.8 · System.OsString.Internal.Types

valueaccessTimeFromMetadata :: Metadata -> UTCTime

#

valueallWriteMode :: FileMode

#

valueatWhetherFollow :: WhetherFollow -> CInt

#

valuec_AT_FDCWD :: Fd

#

valuec_AT_SYMLINK_NOFOLLOW :: CInt

#

valuec_PATH_MAX :: Maybe Int

#

valuec_fchmodat :: Fd -> CString -> FileMode -> CInt -> IO CInt

#

valuec_free :: Ptr a -> IO ()

#

valuec_fstatat :: Fd -> CString -> Ptr CStat -> CInt -> IO CInt

#

valuec_realpath :: CString -> CString -> IO CString

#

valuec_unlinkat :: Fd -> CString -> CInt -> IO CInt

#

valuecanonicalizePathSimplify :: OsPath -> IO OsPath

#

valuecloseRaw :: RawHandle -> IO ()

#

valuecopyFileContents

:: OsPath
Source filename
-> OsPath
Destination filename
-> IO ()

#

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.

valuecopyFileWithMetadataInternal

:: Metadata -> OsPath -> IO ()
-> Metadata -> OsPath -> IO ()
-> OsPath
-> OsPath
-> IO ()

#

valuecopyGroupFromStatus :: FileStatus -> OsPath -> IO ()

#

valuecopyOwnerFromStatus :: FileStatus -> OsPath -> IO ()

#

valuecreateDirectoryInternal :: OsPath -> IO ()

#

valuecreateHardLink :: OsPath -> OsPath -> IO ()

#

valuecreateSymbolicLink :: Bool -> OsPath -> OsPath -> IO ()

#

valuedefaultOpenFlags :: OpenFileFlags

#

valueexeExtensionInternal :: OsString

#

valuefileSizeFromMetadata :: Metadata -> Integer

#

valuefileTypeFromMetadata :: Metadata -> FileType

#

valuefilesAlwaysRemovable :: Bool

#

valuefindExecutablesLazyInternal

:: [OsPath] -> OsString -> ListT IO OsPath
-> OsString
-> ListT IO OsPath

#

valuegetAccessPermissions :: OsPath -> IO Permissions

#

valuegetAppUserDataDirectoryInternal :: OsPath -> IO OsPath

#

valuegetCurrentDirectoryInternal :: IO OsPath

#

valuegetDirectoryContentsInternal :: OsPath -> IO [OsPath]

#

valuegetEnvOs :: OsString -> IO OsString

#

valuegetFileMetadata :: OsPath -> IO Metadata

#

valuegetHomeDirectoryInternal :: IO OsPath

#

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

valuegetMetadataAt :: WhetherFollow -> Maybe RawHandle -> OsPath -> IO Metadata

#

valuegetPath :: IO [OsPath]

#

valuegetSymbolicLinkMetadata :: OsPath -> IO Metadata

#

valuegetTemporaryDirectoryInternal :: IO OsPath

#

valuegetUserDocumentsDirectoryInternal :: IO OsPath

#

valuegetXdgDirectoryFallback :: IO OsPath -> XdgDirectory -> IO OsPath

#

valuegetXdgDirectoryListFallback :: XdgDirectoryList -> IO [OsPath]

#

valuehasWriteMode :: Mode -> Bool

#

valuelinkToDirectoryIsDirectory :: Bool

#

valuelookupEnvOs :: OsString -> IO (Maybe OsString)

#

valuemodeFromMetadata :: Metadata -> Mode

#

valuemodificationTimeFromMetadata :: Metadata -> UTCTime

#

valueopenDirFromFd :: Fd -> IO DirStream

#

valueopenRaw :: WhetherFollow -> Maybe RawHandle -> OsPath -> IO RawHandle

#

valueprependCurrentDirectory :: OsPath -> IO OsPath

#

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.