Data.ByteString.Char8 uses IO functions exported from Data.ByteString
[packages/bytestring.git] / README.md
1 ## ByteString: Fast, Packed Strings of Bytes
2
3 [![Build Status](https://secure.travis-ci.org/haskell/bytestring.png?branch=master)](http://travis-ci.org/haskell/bytestring)
4
5 This library provides the `Data.ByteString` module -- strict and lazy
6 byte arrays manipulable as strings -- providing very time/space-efficient 
7 string and IO operations.
8
9 For very large data requirements, or constraints on heap size,
10 `Data.ByteString.Lazy` is provided, a lazy list of bytestring chunks.
11 Efficient processing of multi-gigabyte data can be achieved this way.
12
13 The library also provides `Data.ByteString.Builder` for efficient construction
14 of `ByteString` values from smaller pieces during binary serialization.
15
16 Requirements:
17
18   * Cabal 1.10 or greater
19   * cabal-install
20   * GHC 6.12 or greater
21
22 Building:
23 ```
24 cabal install
25 ```
26
27 You can run the testsuite as follows:
28 ```    
29 cabal test
30 ```
31
32 ### Authors
33 `ByteString` was derived from the GHC `PackedString` library,
34 originally written by Bryan O'Sullivan, and then by Simon Marlow.
35 It was adapted and greatly extended for darcs by David Roundy and
36 others. Don Stewart and Duncan Coutts cleaned up and further extended
37 the implementation and added the `.Lazy` code. Simon Meier contributed
38 the `Builder` feature.