Copyright	(c) The University of Glasgow 2022
License	BSD-style (see the file libraries/base/LICENSE)
Maintainer	libraries@haskell.org
Stability	provisional
Portability	non-portable (requires POSIX)
Safe Haskell	Safe-Inferred
Language	Haskell2010

System.Posix.Directory.Internals

Description

POSIX directory support (internal module, no PVP guarantees)

Synopsis

newtype DirStream = DirStream (Ptr CDir)
data CDir
data CDirent
newtype DirStreamOffset = DirStreamOffset COff
newtype DirStreamWithPath a = DirStreamWithPath (a, Ptr CDir)
fromDirStreamWithPath :: DirStreamWithPath a -> DirStream
toDirStreamWithPath :: a -> DirStream -> DirStreamWithPath a
newtype DirEnt = DirEnt (Ptr CDirent)
dirEntName :: DirEnt -> IO CString
dirEntType :: DirEnt -> IO DirType
newtype DirType where
- DirType CChar
- pattern UnknownType :: DirType
- pattern NamedPipeType :: DirType
- pattern CharacterDeviceType :: DirType
- pattern DirectoryType :: DirType
- pattern BlockDeviceType :: DirType
- pattern RegularFileType :: DirType
- pattern SymbolicLinkType :: DirType
- pattern SocketType :: DirType
- pattern WhiteoutType :: DirType
isUnknownType :: DirType -> Bool
isNamedPipeType :: DirType -> Bool
isCharacterDeviceType :: DirType -> Bool
isDirectoryType :: DirType -> Bool
isBlockDeviceType :: DirType -> Bool
isRegularFileType :: DirType -> Bool
isSymbolicLinkType :: DirType -> Bool
isSocketType :: DirType -> Bool
isWhiteoutType :: DirType -> Bool
getRealDirType :: IO FileStatus -> DirType -> IO DirType
readDirStreamWith :: (DirEnt -> IO a) -> DirStream -> IO (Maybe a)
readDirStreamWithPtr :: Ptr DirEnt -> (DirEnt -> IO a) -> DirStream -> IO (Maybe a)

Documentation

newtype DirStream Source #

Constructors

DirStream (Ptr CDir)

data CDir Source #

data CDirent Source #

newtype DirStreamOffset Source #

Constructors

DirStreamOffset COff

newtype DirStreamWithPath a Source #

Since: 2.8.6.0

Constructors

DirStreamWithPath (a, Ptr CDir)

fromDirStreamWithPath :: DirStreamWithPath a -> DirStream Source #

Convert a DirStreamWithPath to a DirStream. Note that the underlying pointer is shared by both values, hence any modification to the resulting DirStream will also modify the original DirStreamWithPath.

Since: 2.8.6.0

toDirStreamWithPath :: a -> DirStream -> DirStreamWithPath a Source #

Construct a DirStreamWithPath from a DirStream. Note that the underlying pointer is shared by both values, hence any modification to the pointer of the resulting DirStreamWithPath will also modify the original DirStream.

Since: 2.8.6.0

newtype DirEnt Source #

Since: 2.8.6.0

Constructors

DirEnt (Ptr CDirent)

Instances

Instances details

Storable DirEnt Source #
Instance details Defined in System.Posix.Directory.Common Methods sizeOf :: DirEnt -> Int # alignment :: DirEnt -> Int # peekElemOff :: Ptr DirEnt -> Int -> IO DirEnt # pokeElemOff :: Ptr DirEnt -> Int -> DirEnt -> IO () # peekByteOff :: Ptr b -> Int -> IO DirEnt # pokeByteOff :: Ptr b -> Int -> DirEnt -> IO () # peek :: Ptr DirEnt -> IO DirEnt # poke :: Ptr DirEnt -> DirEnt -> IO () #

dirEntName :: DirEnt -> IO CString Source #

Since: 2.8.6.0

dirEntType :: DirEnt -> IO DirType Source #

Since: 2.8.6.0

newtype DirType Source #

The value of the d_type field of a dirent struct. Note that the possible values of that type depend on the filesystem that is queried. From readdir(3):

Currently, only some filesystems (among them: Btrfs, ext2, ext3, and ext4)
have full support for returning the file type in d_type. All applications
must properly handle a return of DT_UNKNOWN.

For example, JFS is a filesystem that does not support d_type; See https://github.com/haskell/ghcup-hs/issues/766

Furthermore, dirent or the constants represented by the associated pattern synonyms of this type may not be provided by the underlying platform. In that case none of those patterns will match and the application must handle that case accordingly.

Since: 2.8.6.0

Constructors

DirType CChar

Bundled Patterns

pattern UnknownType :: DirType	The `DirType` refers to an entry of unknown type.
pattern NamedPipeType :: DirType	The `DirType` refers to an entry that is a named pipe.
pattern CharacterDeviceType :: DirType	The `DirType` refers to an entry that is a character device.
pattern DirectoryType :: DirType	The `DirType` refers to an entry that is a directory.
pattern BlockDeviceType :: DirType	The `DirType` refers to an entry that is a block device.
pattern RegularFileType :: DirType	The `DirType` refers to an entry that is a regular file.
pattern SymbolicLinkType :: DirType	The `DirType` refers to an entry that is a symbolic link.
pattern SocketType :: DirType	The `DirType` refers to an entry that is a socket.
pattern WhiteoutType :: DirType	The `DirType` refers to an entry that is a whiteout.

Instances

Instances details

Show DirType Source #
Instance details Defined in System.Posix.Directory.Common Methods showsPrec :: Int -> DirType -> ShowS # show :: DirType -> String # showList :: [DirType] -> ShowS #
Eq DirType Source #
Instance details Defined in System.Posix.Directory.Common Methods (==) :: DirType -> DirType -> Bool # (/=) :: DirType -> DirType -> Bool #
Ord DirType Source #
Instance details Defined in System.Posix.Directory.Common Methods compare :: DirType -> DirType -> Ordering # (<) :: DirType -> DirType -> Bool # (<=) :: DirType -> DirType -> Bool # (>) :: DirType -> DirType -> Bool # (>=) :: DirType -> DirType -> Bool # max :: DirType -> DirType -> DirType # min :: DirType -> DirType -> DirType #

isUnknownType :: DirType -> Bool Source #

Checks if this DirType refers to an entry of unknown type.

Since: 2.8.6.0

isNamedPipeType :: DirType -> Bool Source #

Checks if this DirType refers to a named pipe entry.

Since: 2.8.6.0

isCharacterDeviceType :: DirType -> Bool Source #

Checks if this DirType refers to a character device entry.

Since: 2.8.6.0

isDirectoryType :: DirType -> Bool Source #

Checks if this DirType refers to a directory entry.

Since: 2.8.6.0

isBlockDeviceType :: DirType -> Bool Source #

Checks if this DirType refers to a block device entry.

Since: 2.8.6.0

isRegularFileType :: DirType -> Bool Source #

Checks if this DirType refers to a regular file entry.

Since: 2.8.6.0

isSymbolicLinkType :: DirType -> Bool Source #

Checks if this DirType refers to a symbolic link entry.

Since: 2.8.6.0

isSocketType :: DirType -> Bool Source #

Checks if this DirType refers to a socket entry.

Since: 2.8.6.0

isWhiteoutType :: DirType -> Bool Source #

Checks if this DirType refers to a whiteout entry.

Since: 2.8.6.0

getRealDirType :: IO FileStatus -> DirType -> IO DirType Source #

Since: 2.8.6.0

readDirStreamWith :: (DirEnt -> IO a) -> DirStream -> IO (Maybe a) Source #

readDirStreamWith f dp calls readdir to obtain the next directory entry (struct dirent) for the open directory stream dp. If an entry is read, it passes the pointer to that structure to the provided function f for processing. It returns the result of that function call wrapped in a Just if an entry was read and Nothing if the end of the directory stream was reached.

NOTE: The lifetime of the pointer wrapped in the DirEnt is limited to invocation of the callback and it will be freed automatically after. Do not pass it to the outside world!

Since: 2.8.6.0

readDirStreamWithPtr :: Ptr DirEnt -> (DirEnt -> IO a) -> DirStream -> IO (Maybe a) Source #

A version of readDirStreamWith that takes a pre-allocated pointer in addition to the other arguments. This pointer is used to store the pointer to the next directory entry, if there is any. This function is intended for use cases where you need to read a lot of directory entries and want to reuse the pointer for each of them. Using for example readDirStream or readDirStreamWith in this scenario would allocate a new pointer for each call of these functions.

NOTE: You are responsible for releasing the pointer after you are done.

Since: 2.8.6.0