The io-streams package

[Tags:bsd3, library, test]


The io-streams library contains simple and easy-to-use primitives for I/O using streams. Most users will want to import the top-level convenience module System.IO.Streams, which re-exports most of the library:

import           System.IO.Streams (InputStream, OutputStream)
import qualified System.IO.Streams as Streams

For first-time users, io-streams comes with an included tutorial, which can be found in the System.IO.Streams.Tutorial module.


The io-streams user API has two basic types: InputStream a and OutputStream a, and three fundamental I/O primitives:

-- read an item from an input stream :: InputStream a -> IO (Maybe a)

-- push an item back to an input stream
Streams.unRead :: a -> InputStream a -> IO ()

-- write to an output stream
Streams.write :: Maybe a -> OutputStream a -> IO ()

Streams can be transformed by composition and hooked together with provided combinators:

ghci> Streams.fromList [1,2,3::Int] >>= (*10) >>= Streams.toList

Stream composition leaves the original stream accessible:

ghci> input <- Streams.fromByteString "long string"
ghci> wrapped <- Streams.takeBytes 4 input
ghci> wrapped
Just "long"
ghci> wrapped
ghci> input
Just " string"

Simple types and operations in the IO monad mean straightforward and simple exception handling and resource cleanup using Haskell standard library facilities like Control.Exception.bracket.

io-streams comes with:

[Skip to Readme]


Change log
Dependencies attoparsec (>=0.10 && <0.14), base (==4.*), bytestring (>=0.9 && <0.11), bytestring-builder (==0.10.*), network (>=2.3 && <2.7), primitive (>=0.2 && <0.7), process (>=1.1 && <1.7), text (>=0.10 && <1.3), time (>=1.2 && <1.9), transformers (>=0.2 && <0.6), vector (>=0.7 && <0.13), zlib-bindings (==0.1.*) [details]
License BSD3
Maintainer Gregory Collins <>
Category Data, Network, IO-Streams
Bug tracker
Source repository head: git clone
Uploaded Fri Mar 24 21:43:29 UTC 2017 by GregoryCollins
Distributions Debian:, Fedora:, LTSHaskell:, NixOS:, Stackage:, Tumbleweed:
Downloads 20388 total (929 in the last 30 days)
3 []
Status Docs available [build log]
Last success reported on 2017-03-24 [all 1 reports]




nointeractivetestsDo not run interactive testsDisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees

Readme for io-streams

Readme for io-streams-

The io-streams library contains simple and easy to use primitives for I/O using streams. Based on simple types with one type parameter (InputStream a and OutputStream a), io-streams provides a basic interface to side-effecting input and output in IO monad with the following features:

  • three fundamental I/O primitives that anyone can understand: read :: InputStream a -> IO (Maybe a), unRead :: a -> InputStream a -> IO (), and write :: Maybe a -> OutputStream a -> IO ().

  • simple types and side-effecting IO operations mean straightforward and simple exception handling and resource cleanup using standard Haskell facilities like bracket.

  • code to transform files, handles, and sockets to streams

  • a variety of combinators for wrapping and transforming streams, including compression and decompression using zlib, controlling precisely how many bytes are read to or written from a socket, buffering output using blaze-builder, etc.

  • support for parsing from streams using attoparsec.