Safe Haskell	Safe-Inferred
Language	Haskell2010

UnliftIO.Streams

Contents

Stream types
Creating streams
Primitive stream operations
Utility streams
Batteries included

Synopsis

data InputStream a
data OutputStream a
makeInputStream :: MonadUnliftIO m => m (Maybe a) -> m (InputStream a)
makeOutputStream :: MonadUnliftIO m => (Maybe a -> m ()) -> m (OutputStream a)
read :: MonadUnliftIO m => InputStream a -> m (Maybe a)
unRead :: MonadUnliftIO m => a -> InputStream a -> m ()
peek :: MonadUnliftIO m => InputStream a -> m (Maybe a)
write :: MonadUnliftIO m => Maybe a -> OutputStream a -> m ()
writeTo :: MonadUnliftIO m => OutputStream a -> Maybe a -> m ()
atEOF :: MonadUnliftIO m => InputStream a -> m Bool
nullInput :: MonadUnliftIO m => m (InputStream a)
nullOutput :: MonadUnliftIO m => m (OutputStream a)
module UnliftIO.Streams.ByteString
module UnliftIO.Streams.Combinators
module UnliftIO.Streams.File
module UnliftIO.Streams.List
module UnliftIO.Streams.Text

Stream types

data InputStream a #

An InputStream generates values of type c in the IO monad.

Two primitive operations are defined on InputStream:

read :: InputStream c -> IO (Maybe c) reads a value from the stream, where "end of stream" is signaled by read returning Nothing.
unRead :: c -> InputStream c -> IO () "pushes back" a value to the stream.

It is intended that InputStreams obey the following law:

unRead c stream >> read stream === return (Just c)

Instances

Instances details

BufferedIO (InputStream ByteString)
Instance details Defined in System.IO.Streams.Internal Methods newBuffer :: InputStream ByteString -> BufferState -> IO (Buffer Word8) # fillReadBuffer :: InputStream ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) # fillReadBuffer0 :: InputStream ByteString -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) # emptyWriteBuffer :: InputStream ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer :: InputStream ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer0 :: InputStream ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) #
BufferedIO (StreamPair ByteString)
Instance details Defined in System.IO.Streams.Internal Methods newBuffer :: StreamPair ByteString -> BufferState -> IO (Buffer Word8) # fillReadBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) # fillReadBuffer0 :: StreamPair ByteString -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) # emptyWriteBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer0 :: StreamPair ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) #
IODevice (InputStream ByteString)
Instance details Defined in System.IO.Streams.Internal Methods ready :: InputStream ByteString -> Bool -> Int -> IO Bool # close :: InputStream ByteString -> IO () # isTerminal :: InputStream ByteString -> IO Bool # isSeekable :: InputStream ByteString -> IO Bool # seek :: InputStream ByteString -> SeekMode -> Integer -> IO Integer # tell :: InputStream ByteString -> IO Integer # getSize :: InputStream ByteString -> IO Integer # setSize :: InputStream ByteString -> Integer -> IO () # setEcho :: InputStream ByteString -> Bool -> IO () # getEcho :: InputStream ByteString -> IO Bool # setRaw :: InputStream ByteString -> Bool -> IO () # devType :: InputStream ByteString -> IO IODeviceType # dup :: InputStream ByteString -> IO (InputStream ByteString) # dup2 :: InputStream ByteString -> InputStream ByteString -> IO (InputStream ByteString) #
IODevice (StreamPair ByteString)
Instance details Defined in System.IO.Streams.Internal Methods ready :: StreamPair ByteString -> Bool -> Int -> IO Bool # close :: StreamPair ByteString -> IO () # isTerminal :: StreamPair ByteString -> IO Bool # isSeekable :: StreamPair ByteString -> IO Bool # seek :: StreamPair ByteString -> SeekMode -> Integer -> IO Integer # tell :: StreamPair ByteString -> IO Integer # getSize :: StreamPair ByteString -> IO Integer # setSize :: StreamPair ByteString -> Integer -> IO () # setEcho :: StreamPair ByteString -> Bool -> IO () # getEcho :: StreamPair ByteString -> IO Bool # setRaw :: StreamPair ByteString -> Bool -> IO () # devType :: StreamPair ByteString -> IO IODeviceType # dup :: StreamPair ByteString -> IO (StreamPair ByteString) # dup2 :: StreamPair ByteString -> StreamPair ByteString -> IO (StreamPair ByteString) #
RawIO (InputStream ByteString)	The offset argument is ignored if present.
Instance details Defined in System.IO.Streams.Internal Methods read :: InputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int # readNonBlocking :: InputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) # write :: InputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO () # writeNonBlocking :: InputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int #
RawIO (StreamPair ByteString)	The offset argument is ignored if present.
Instance details Defined in System.IO.Streams.Internal Methods read :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int # readNonBlocking :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) # write :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO () # writeNonBlocking :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int #

data OutputStream a #

An OutputStream consumes values of type c in the IO monad. The only primitive operation defined on OutputStream is:

write :: Maybe c -> OutputStream c -> IO ()

Values of type c are written in an OutputStream by wrapping them in Just, and the end of the stream is indicated by supplying Nothing.

If you supply a value after a Nothing, the behavior is defined by the implementer of the given OutputStream. (All OutputStream definitions in this library will simply discard the extra input.)

Instances

Instances details

BufferedIO (OutputStream ByteString)
Instance details Defined in System.IO.Streams.Internal Methods newBuffer :: OutputStream ByteString -> BufferState -> IO (Buffer Word8) # fillReadBuffer :: OutputStream ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) # fillReadBuffer0 :: OutputStream ByteString -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) # emptyWriteBuffer :: OutputStream ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer :: OutputStream ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer0 :: OutputStream ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) #
BufferedIO (StreamPair ByteString)
Instance details Defined in System.IO.Streams.Internal Methods newBuffer :: StreamPair ByteString -> BufferState -> IO (Buffer Word8) # fillReadBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) # fillReadBuffer0 :: StreamPair ByteString -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) # emptyWriteBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer :: StreamPair ByteString -> Buffer Word8 -> IO (Buffer Word8) # flushWriteBuffer0 :: StreamPair ByteString -> Buffer Word8 -> IO (Int, Buffer Word8) #
IODevice (OutputStream ByteString)
Instance details Defined in System.IO.Streams.Internal Methods ready :: OutputStream ByteString -> Bool -> Int -> IO Bool # close :: OutputStream ByteString -> IO () # isTerminal :: OutputStream ByteString -> IO Bool # isSeekable :: OutputStream ByteString -> IO Bool # seek :: OutputStream ByteString -> SeekMode -> Integer -> IO Integer # tell :: OutputStream ByteString -> IO Integer # getSize :: OutputStream ByteString -> IO Integer # setSize :: OutputStream ByteString -> Integer -> IO () # setEcho :: OutputStream ByteString -> Bool -> IO () # getEcho :: OutputStream ByteString -> IO Bool # setRaw :: OutputStream ByteString -> Bool -> IO () # devType :: OutputStream ByteString -> IO IODeviceType # dup :: OutputStream ByteString -> IO (OutputStream ByteString) # dup2 :: OutputStream ByteString -> OutputStream ByteString -> IO (OutputStream ByteString) #
IODevice (StreamPair ByteString)
Instance details Defined in System.IO.Streams.Internal Methods ready :: StreamPair ByteString -> Bool -> Int -> IO Bool # close :: StreamPair ByteString -> IO () # isTerminal :: StreamPair ByteString -> IO Bool # isSeekable :: StreamPair ByteString -> IO Bool # seek :: StreamPair ByteString -> SeekMode -> Integer -> IO Integer # tell :: StreamPair ByteString -> IO Integer # getSize :: StreamPair ByteString -> IO Integer # setSize :: StreamPair ByteString -> Integer -> IO () # setEcho :: StreamPair ByteString -> Bool -> IO () # getEcho :: StreamPair ByteString -> IO Bool # setRaw :: StreamPair ByteString -> Bool -> IO () # devType :: StreamPair ByteString -> IO IODeviceType # dup :: StreamPair ByteString -> IO (StreamPair ByteString) # dup2 :: StreamPair ByteString -> StreamPair ByteString -> IO (StreamPair ByteString) #
RawIO (OutputStream ByteString)	The offset argument is ignored if present.
Instance details Defined in System.IO.Streams.Internal Methods read :: OutputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int # readNonBlocking :: OutputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) # write :: OutputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO () # writeNonBlocking :: OutputStream ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int #
RawIO (StreamPair ByteString)	The offset argument is ignored if present.
Instance details Defined in System.IO.Streams.Internal Methods read :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int # readNonBlocking :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) # write :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO () # writeNonBlocking :: StreamPair ByteString -> Ptr Word8 -> Word64 -> Int -> IO Int #