README.md
1The io-streams library contains simple and easy to use primitives for I/O
2using streams. Based on simple types with one type parameter (`InputStream a`
3and `OutputStream a`), io-streams provides a basic interface to
4side-effecting input and output in `IO` monad with the following
5features:
6
7 * three fundamental I/O primitives that anyone can understand: `read ::
8 InputStream a -> IO (Maybe a)`, `unRead :: a -> InputStream a -> IO ()`,
9 and `write :: Maybe a -> OutputStream a -> IO ()`.
10
11 * simple types and side-effecting IO operations mean straightforward and
12 simple exception handling and resource cleanup using standard Haskell
13 facilities like `bracket`.
14
15 * code to transform files, handles, and sockets to streams
16
17 * a variety of combinators for wrapping and transforming streams, including
18 compression and decompression using zlib, controlling precisely how many
19 bytes are read to or written from a socket, buffering output using
20 `blaze-builder`, etc.
21
22 * support for parsing from streams using `attoparsec`.
23