Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.HaskellNet.BSStream

Description

This module provides a byte string "stream" interface. This interface provides some common operations on a value which supports reading and writing byte strings.

Synopsis

data BSStream = BSStream {
- bsGetLine :: IO ByteString
- bsGet :: Int -> IO ByteString
- bsPut :: ByteString -> IO ()
- bsFlush :: IO ()
- bsClose :: IO ()
- bsIsOpen :: IO Bool
- bsWaitForInput :: Int -> IO Bool
}
handleToStream :: Handle -> BSStream

Documentation

data BSStream Source #

A byte string stream.

Constructors

BSStream

Fields

bsGetLine :: IO ByteString
Read a line from the stream. Should return the line which was read, including the newline.
bsGet :: Int -> IO ByteString
Read the specified number of bytes from the stream. Should block until the requested bytes can be read.
bsPut :: ByteString -> IO ()
Write the specified byte string to the stream. Should flush the stream after writing.
bsFlush :: IO ()
Flush the stream.
bsClose :: IO ()
Close the stream.
bsIsOpen :: IO Bool
Is the stream open?
bsWaitForInput :: Int -> IO Bool
Is data available?

handleToStream :: Handle -> BSStream Source #

Build a byte string stream which operates on a Handle.