GHC.IO.Device

Methods

read :: a -> Ptr Word8 -> Int -> IO Int Source

Read up to the specified number of bytes, returning the number of bytes actually read. This function should only block if there is no data available. If there is not enough data available, then the function should just return the available data. A return value of zero indicates that the end of the data stream (e.g. end of file) has been reached.

readNonBlocking :: a -> Ptr Word8 -> Int -> IO (Maybe Int) Source

Read up to the specified number of bytes, returning the number of bytes actually read, or Nothing if the end of the stream has been reached.

write :: a -> Ptr Word8 -> Int -> IO () Source

Write the specified number of bytes.

writeNonBlocking :: a -> Ptr Word8 -> Int -> IO Int Source

Write up to the specified number of bytes without blocking. Returns the actual number of bytes written.

Methods

ready :: a -> Bool -> Int -> IO Bool Source

ready dev write msecs returns True if the device has data to read (if write is False) or space to write new data (if write is True). msecs specifies how long to wait, in milliseconds.

close :: a -> IO () Source

closes the device. Further operations on the device should produce exceptions.

isTerminal :: a -> IO Bool Source

returns True if the device is a terminal or console.

isSeekable :: a -> IO Bool Source

returns True if the device supports seek operations.

seek :: a -> SeekMode -> Integer -> IO () Source

seek to the specified position in the data.

tell :: a -> IO Integer Source

return the current position in the data.

getSize :: a -> IO Integer Source

return the size of the data.

setSize :: a -> Integer -> IO () Source

change the size of the data.

setEcho :: a -> Bool -> IO () Source

for terminal devices, changes whether characters are echoed on the device.

getEcho :: a -> IO Bool Source

returns the current echoing status.

setRaw :: a -> Bool -> IO () Source

some devices (e.g. terminals) support a "raw" mode where characters entered are immediately made available to the program. If available, this operations enables raw mode.

devType :: a -> IO IODeviceType Source

returns the IODeviceType corresponding to this device.

dup :: a -> IO a Source

duplicates the device, if possible. The new device is expected to share a file pointer with the original device (like Unix dup).

dup2 :: a -> a -> IO a Source

dup2 source target replaces the target device with the source device. The target device is closed first, if necessary, and then it is made into a duplicate of the first device (like Unix dup2).