Copyright	(c) The University of Glasgow 1994-2008
License	see libraries/base/LICENSE
Maintainer	libraries@haskell.org
Stability	internal
Portability	non-portable
Safe Haskell	Trustworthy
Language	Haskell2010

GHC.IO.FD

Description

Raw read/write operations on file descriptors

Synopsis

data FD = FD {
- fdFD :: !CInt
- fdIsNonBlocking :: !Int
}
openFile :: FilePath -> IOMode -> Bool -> IO (FD, IODeviceType)
mkFD :: CInt -> IOMode -> Maybe (IODeviceType, CDev, CIno) -> Bool -> Bool -> IO (FD, IODeviceType)
release :: FD -> IO ()
setNonBlockingMode :: FD -> Bool -> IO FD
readRawBufferPtr :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO Int
readRawBufferPtrNoBlock :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO Int
writeRawBufferPtr :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO CInt
stdin :: FD
stdout :: FD
stderr :: FD

Documentation

data FD #

Constructors

FD
Fields fdFD :: !CInt fdIsNonBlocking :: !Int

Instances

Instances details

Show FD #	Since: base-4.1.0.0
Instance details Defined in GHC.IO.FD Methods showsPrec :: Int -> FD -> ShowS # show :: FD -> String # showList :: [FD] -> ShowS #
IODevice FD #	Since: base-4.1.0.0
Instance details Defined in GHC.IO.FD Methods ready :: FD -> Bool -> Int -> IO Bool # close :: FD -> IO () # isTerminal :: FD -> IO Bool # isSeekable :: FD -> IO Bool # seek :: FD -> SeekMode -> Integer -> IO () # tell :: FD -> IO Integer # getSize :: FD -> IO Integer # setSize :: FD -> Integer -> IO () # setEcho :: FD -> Bool -> IO () # getEcho :: FD -> IO Bool # setRaw :: FD -> Bool -> IO () # devType :: FD -> IO IODeviceType # dup :: FD -> IO FD # dup2 :: FD -> FD -> IO FD #
RawIO FD #	Since: base-4.1.0.0
Instance details Defined in GHC.IO.FD Methods read :: FD -> Ptr Word8 -> Int -> IO Int # readNonBlocking :: FD -> Ptr Word8 -> Int -> IO (Maybe Int) # write :: FD -> Ptr Word8 -> Int -> IO () # writeNonBlocking :: FD -> Ptr Word8 -> Int -> IO Int #
BufferedIO FD #	Since: base-4.1.0.0
Instance details Defined in GHC.IO.FD Methods newBuffer :: FD -> BufferState -> IO (Buffer Word8) # fillReadBuffer :: FD -> Buffer Word8 -> IO (Int, Buffer Word8) # fillReadBuffer0 :: FD -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) # emptyWriteBuffer :: FD -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer :: FD -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer0 :: FD -> Buffer Word8 -> IO (Int, Buffer Word8) #

openFile #

Arguments

:: FilePath	file to open
-> IOMode	mode in which to open the file
-> Bool	open the file in non-blocking mode?
-> IO (FD, IODeviceType)

Open a file and make an FD for it. Truncates the file to zero size when the IOMode is WriteMode.

mkFD #

Arguments

:: CInt
-> IOMode
-> Maybe (IODeviceType, CDev, CIno)
-> Bool	is a socket (on Windows)
-> Bool	is in non-blocking mode on Unix
-> IO (FD, IODeviceType)

Make a FD from an existing file descriptor. Fails if the FD refers to a directory. If the FD refers to a file, mkFD locks the file according to the Haskell 2010 single writer/multiple reader locking semantics (this is why we need the IOMode argument too).

release :: FD -> IO () #

setNonBlockingMode :: FD -> Bool -> IO FD #

readRawBufferPtr :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO Int #

readRawBufferPtrNoBlock :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO Int #

writeRawBufferPtr :: String -> FD -> Ptr Word8 -> Int -> CSize -> IO CInt #

stdin :: FD #

stdout :: FD #

stderr :: FD #