Safe Haskell	Safe-Inferred
Language	Haskell2010

Posix.File

Contents

Functions
Types
File Descriptor Flags
Open Access Mode
File Creation Flags

Synopsis

uninterruptibleGetDescriptorFlags :: Fd -> IO (Either Errno DescriptorFlags)
uninterruptibleGetStatusFlags :: Fd -> IO (Either Errno StatusFlags)
uninterruptibleWriteByteArray :: Fd -> ByteArray -> Int -> CSize -> IO (Either Errno CSize)
uninterruptibleWriteBytes :: Fd -> Bytes -> IO (Either Errno CSize)
uninterruptibleWriteBytesCompletely :: Fd -> Bytes -> IO (Either Errno ())
uninterruptibleWriteBytesCompletelyErrno :: Fd -> Bytes -> IO Errno
uninterruptibleReadMutableByteArray :: Fd -> MutableByteArray RealWorld -> Int -> CSize -> IO (Either Errno CSize)
writeBytesCompletelyErrno :: Fd -> Bytes -> IO Errno
uninterruptibleOpen :: ManagedCString -> AccessMode -> CreationFlags -> StatusFlags -> IO (Either Errno Fd)
uninterruptibleOpenMode :: ManagedCString -> AccessMode -> CreationFlags -> StatusFlags -> CMode -> IO (Either Errno Fd)
uninterruptibleOpenUntypedFlags :: ManagedCString -> CInt -> IO (Either Errno Fd)
uninterruptibleOpenModeUntypedFlags :: ManagedCString -> CInt -> CMode -> IO (Either Errno Fd)
writeByteArray :: Fd -> ByteArray -> Int -> CSize -> IO (Either Errno CSize)
writeMutableByteArray :: Fd -> MutableByteArray RealWorld -> Int -> CSize -> IO (Either Errno CSize)
close :: Fd -> IO (Either Errno ())
uninterruptibleClose :: Fd -> IO (Either Errno ())
uninterruptibleErrorlessClose :: Fd -> IO ()
uninterruptibleUnlink :: ManagedCString -> IO (Either Errno ())
uninterruptibleLink :: ManagedCString -> ManagedCString -> IO (Either Errno ())
newtype AccessMode = AccessMode CInt
newtype CreationFlags = CreationFlags CInt
newtype DescriptorFlags = DescriptorFlags CInt
newtype StatusFlags = StatusFlags CInt
nonblocking :: StatusFlags
append :: StatusFlags
isReadOnly :: StatusFlags -> Bool
isWriteOnly :: StatusFlags -> Bool
isReadWrite :: StatusFlags -> Bool
readOnly :: AccessMode
writeOnly :: AccessMode
readWrite :: AccessMode
create :: CreationFlags
truncate :: CreationFlags
exclusive :: CreationFlags

Functions

uninterruptibleGetDescriptorFlags :: Fd -> IO (Either Errno DescriptorFlags) Source #

Get file descriptor flags. This uses the unsafe FFI to perform fcntl(fd,F_GETFD).

uninterruptibleGetStatusFlags :: Fd -> IO (Either Errno StatusFlags) Source #

Get file status flags. This uses the unsafe FFI to perform fcntl(fd,F_GETFL).

uninterruptibleWriteByteArray Source #

Arguments

:: Fd	Socket
-> ByteArray	Source byte array
-> Int	Offset into source array
-> CSize	Length in bytes
-> IO (Either Errno CSize)	Number of bytes pushed to send buffer

Wrapper for write(2) that takes a byte array and an offset. The byte array does not need to be pinned.

uninterruptibleWriteBytes Source #

Arguments

:: Fd	File descriptor
-> Bytes	Source bytes
-> IO (Either Errno CSize)	Number of bytes written

Wrapper for write(2) that takes a slice of bytes and an offset. The byte array backing the slice does not need to be pinned.

uninterruptibleWriteBytesCompletely Source #

Arguments

:: Fd	File descriptor
-> Bytes	Source bytes
-> IO (Either Errno ())

Wrapper for write(2) that takes a slice of bytes and an offset. The byte array backing the slice does not need to be pinned.

uninterruptibleWriteBytesCompletelyErrno Source #

Arguments

:: Fd	File descriptor
-> Bytes	Source bytes
-> IO Errno

Variant of uninterruptibleWriteBytesCompletely that uses errno 0 to communicate success.

uninterruptibleReadMutableByteArray Source #

Arguments

:: Fd	File descriptor
-> MutableByteArray RealWorld	Destination
-> Int	Destination offset
-> CSize	Length in bytes
-> IO (Either Errno CSize)	Number of bytes received

writeBytesCompletelyErrno Source #

Arguments

:: Fd	File descriptor
-> Bytes	Source bytes
-> IO Errno

Wrapper for write(2) that takes a slice of bytes and an offset. The byte array backing the slice must be pinned.

uninterruptibleOpen Source #

Arguments

:: ManagedCString	NULL-terminated file name
-> AccessMode	Access mode
-> CreationFlags	Creation flags
-> StatusFlags	Status flags
-> IO (Either Errno Fd)

uninterruptibleOpenMode Source #

Arguments

:: ManagedCString	NULL-terminated file name
-> AccessMode	Access mode, should include `O_CREAT`
-> CreationFlags	Creation flags
-> StatusFlags	Status flags
-> CMode	Permissions assigned to newly created file
-> IO (Either Errno Fd)

uninterruptibleOpenUntypedFlags Source #

Arguments

:: ManagedCString	NULL-terminated file name
-> CInt	Flags
-> IO (Either Errno Fd)

Variant of uninterruptibleOpen that does not help the caller with the types of the flags.

uninterruptibleOpenModeUntypedFlags Source #

Arguments

:: ManagedCString	NULL-terminated file name
-> CInt	Flags
-> CMode	Mode
-> IO (Either Errno Fd)

Variant of uninterruptibleOpenMode that does not help the caller with the types of the flags.

writeByteArray Source #

Arguments

:: Fd	File descriptor
-> ByteArray	Source byte array
-> Int	Offset into source array
-> CSize	Length in bytes
-> IO (Either Errno CSize)	Number of bytes pushed to send buffer

Wrapper for write(2) that takes a byte array and an offset. Uses safe FFI. The byte array must be pinned.

writeMutableByteArray Source #

Arguments

:: Fd	File descriptor
-> MutableByteArray RealWorld	Source byte array
-> Int	Offset into source array
-> CSize	Length in bytes
-> IO (Either Errno CSize)	Number of bytes pushed to send buffer

Variant of writeByteArray that operates on mutable byte array. Uses safe FFI. The byte array must be pinned.

close Source #

Arguments

:: Fd	Socket
-> IO (Either Errno ())

Close a file descriptor. The POSIX specification includes more details. This uses the safe FFI.

uninterruptibleClose Source #

Arguments

:: Fd	Socket
-> IO (Either Errno ())

Close a file descriptor. This uses the unsafe FFI. According to the POSIX specification, "If fildes refers to a socket, close() shall cause the socket to be destroyed. If the socket is in connection-mode, and the SO_LINGER option is set for the socket with non-zero linger time, and the socket has untransmitted data, then close() shall block for up to the current linger interval until all data is transmitted."

uninterruptibleErrorlessClose Source #

Arguments

:: Fd	Socket
-> IO ()

Close a file descriptor with the unsafe FFI. Do not check for errors. It is only appropriate to use this when a file descriptor is being closed to handle an exceptional case. Since the user will want to propogate the original exception, the exception provided by uninterruptibleClose would just be discarded. This function allows us to potentially avoid an additional FFI call to getErrno.

uninterruptibleUnlink Source #

Arguments

:: ManagedCString	File name
-> IO (Either Errno ())

uninterruptibleLink Source #

Arguments

:: ManagedCString	Path to existing file
-> ManagedCString	Path to new file
-> IO (Either Errno ())

Types

newtype AccessMode Source #

Constructors

AccessMode CInt

Instances

Instances details

Eq AccessMode Source #
Instance details Defined in Posix.File.Types Methods (==) :: AccessMode -> AccessMode -> Bool # (/=) :: AccessMode -> AccessMode -> Bool #

newtype CreationFlags Source #

File Creation Flags

Constructors

CreationFlags CInt

Instances

Instances details

Monoid CreationFlags Source #
Instance details Defined in Posix.File.Types Methods mempty :: CreationFlags # mappend :: CreationFlags -> CreationFlags -> CreationFlags # mconcat :: [CreationFlags] -> CreationFlags #
Semigroup CreationFlags Source #
Instance details Defined in Posix.File.Types Methods (<>) :: CreationFlags -> CreationFlags -> CreationFlags # sconcat :: NonEmpty CreationFlags -> CreationFlags # stimes :: Integral b => b -> CreationFlags -> CreationFlags #
Bits CreationFlags Source #
Instance details Defined in Posix.File.Types Methods (.&.) :: CreationFlags -> CreationFlags -> CreationFlags # (.\|.) :: CreationFlags -> CreationFlags -> CreationFlags # xor :: CreationFlags -> CreationFlags -> CreationFlags # complement :: CreationFlags -> CreationFlags # shift :: CreationFlags -> Int -> CreationFlags # rotate :: CreationFlags -> Int -> CreationFlags # zeroBits :: CreationFlags # bit :: Int -> CreationFlags # setBit :: CreationFlags -> Int -> CreationFlags # clearBit :: CreationFlags -> Int -> CreationFlags # complementBit :: CreationFlags -> Int -> CreationFlags # testBit :: CreationFlags -> Int -> Bool # bitSizeMaybe :: CreationFlags -> Maybe Int # bitSize :: CreationFlags -> Int # isSigned :: CreationFlags -> Bool # shiftL :: CreationFlags -> Int -> CreationFlags # unsafeShiftL :: CreationFlags -> Int -> CreationFlags # shiftR :: CreationFlags -> Int -> CreationFlags # unsafeShiftR :: CreationFlags -> Int -> CreationFlags # rotateL :: CreationFlags -> Int -> CreationFlags # rotateR :: CreationFlags -> Int -> CreationFlags # popCount :: CreationFlags -> Int #
Eq CreationFlags Source #
Instance details Defined in Posix.File.Types Methods (==) :: CreationFlags -> CreationFlags -> Bool # (/=) :: CreationFlags -> CreationFlags -> Bool #

newtype DescriptorFlags Source #

File Descriptor Flags

Constructors

DescriptorFlags CInt

Instances

Instances details

Monoid DescriptorFlags Source #
Instance details Defined in Posix.File.Types Methods mempty :: DescriptorFlags # mappend :: DescriptorFlags -> DescriptorFlags -> DescriptorFlags # mconcat :: [DescriptorFlags] -> DescriptorFlags #
Semigroup DescriptorFlags Source #
Instance details Defined in Posix.File.Types Methods (<>) :: DescriptorFlags -> DescriptorFlags -> DescriptorFlags # sconcat :: NonEmpty DescriptorFlags -> DescriptorFlags # stimes :: Integral b => b -> DescriptorFlags -> DescriptorFlags #
Bits DescriptorFlags Source #
Instance details Defined in Posix.File.Types Methods (.&.) :: DescriptorFlags -> DescriptorFlags -> DescriptorFlags # (.\|.) :: DescriptorFlags -> DescriptorFlags -> DescriptorFlags # xor :: DescriptorFlags -> DescriptorFlags -> DescriptorFlags # complement :: DescriptorFlags -> DescriptorFlags # shift :: DescriptorFlags -> Int -> DescriptorFlags # rotate :: DescriptorFlags -> Int -> DescriptorFlags # zeroBits :: DescriptorFlags # bit :: Int -> DescriptorFlags # setBit :: DescriptorFlags -> Int -> DescriptorFlags # clearBit :: DescriptorFlags -> Int -> DescriptorFlags # complementBit :: DescriptorFlags -> Int -> DescriptorFlags # testBit :: DescriptorFlags -> Int -> Bool # bitSizeMaybe :: DescriptorFlags -> Maybe Int # bitSize :: DescriptorFlags -> Int # isSigned :: DescriptorFlags -> Bool # shiftL :: DescriptorFlags -> Int -> DescriptorFlags # unsafeShiftL :: DescriptorFlags -> Int -> DescriptorFlags # shiftR :: DescriptorFlags -> Int -> DescriptorFlags # unsafeShiftR :: DescriptorFlags -> Int -> DescriptorFlags # rotateL :: DescriptorFlags -> Int -> DescriptorFlags # rotateR :: DescriptorFlags -> Int -> DescriptorFlags # popCount :: DescriptorFlags -> Int #
Eq DescriptorFlags Source #
Instance details Defined in Posix.File.Types Methods (==) :: DescriptorFlags -> DescriptorFlags -> Bool # (/=) :: DescriptorFlags -> DescriptorFlags -> Bool #

newtype StatusFlags Source #

File Status Flags

Constructors

StatusFlags CInt

Instances

Instances details

Monoid StatusFlags Source #
Instance details Defined in Posix.File.Types Methods mempty :: StatusFlags # mappend :: StatusFlags -> StatusFlags -> StatusFlags # mconcat :: [StatusFlags] -> StatusFlags #
Semigroup StatusFlags Source #
Instance details Defined in Posix.File.Types Methods (<>) :: StatusFlags -> StatusFlags -> StatusFlags # sconcat :: NonEmpty StatusFlags -> StatusFlags # stimes :: Integral b => b -> StatusFlags -> StatusFlags #
Bits StatusFlags Source #
Instance details Defined in Posix.File.Types Methods (.&.) :: StatusFlags -> StatusFlags -> StatusFlags # (.\|.) :: StatusFlags -> StatusFlags -> StatusFlags # xor :: StatusFlags -> StatusFlags -> StatusFlags # complement :: StatusFlags -> StatusFlags # shift :: StatusFlags -> Int -> StatusFlags # rotate :: StatusFlags -> Int -> StatusFlags # zeroBits :: StatusFlags # bit :: Int -> StatusFlags # setBit :: StatusFlags -> Int -> StatusFlags # clearBit :: StatusFlags -> Int -> StatusFlags # complementBit :: StatusFlags -> Int -> StatusFlags # testBit :: StatusFlags -> Int -> Bool # bitSizeMaybe :: StatusFlags -> Maybe Int # bitSize :: StatusFlags -> Int # isSigned :: StatusFlags -> Bool # shiftL :: StatusFlags -> Int -> StatusFlags # unsafeShiftL :: StatusFlags -> Int -> StatusFlags # shiftR :: StatusFlags -> Int -> StatusFlags # unsafeShiftR :: StatusFlags -> Int -> StatusFlags # rotateL :: StatusFlags -> Int -> StatusFlags # rotateR :: StatusFlags -> Int -> StatusFlags # popCount :: StatusFlags -> Int #
Eq StatusFlags Source #
Instance details Defined in Posix.File.Types Methods (==) :: StatusFlags -> StatusFlags -> Bool # (/=) :: StatusFlags -> StatusFlags -> Bool #