Safe Haskell	Safe-Inferred
Language	Haskell2010

UnliftIO.Streams.Internal

Synopsis

data InputStream a = InputStream {
- _read :: IO (Maybe a)
- _unRead :: a -> IO ()
}

Documentation

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)

Constructors

InputStream
Fields _read :: IO (Maybe a) _unRead :: a -> IO ()

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 #