Version 4 (modified by dons@…, 9 years ago) (diff)

Polish the BinaryIO story

Binary I/O

Haskell 98 treats I/O as character-based, and lacks a well-defined mechanism for binary I/O. However, a number of external libraries exist providing various forms of binary I/O.

Two forms of binary I/O are considered here:

  • Word8 based extensions to Syste.IO, and
  • Typeclass-based Binary I/O (referred to as Binary) for serialising arbitrary data types, layered over Word8 extensions


  • Character-based I/O is needed, at least because systems (e.g. Unix and Windows) have different line-termination conventions that should be hidden from programs. The problem becomes more acute when different environments use different character sets and encodings (see Unicode).
  • Binary I/O is needed both to handle binary data and as a base upon which general treatment s of character-encoding conversions (see Unicode) may be layered.
  • Type-classed binary I/O is needed to support serialisable structures and peristence for arbitrary Haskell data

Proposal 1 - System.IO

  • One proposal is to add a form of I/O over Word8 (i.e. octets, 8-bit binary values). See the "Binary input and output" section of System.IO for a rough design.

Proposal 2 - The Binary class

  • Proposal two is to add a Binary class, based on the type class described in The Bits Between The Lambdas. The advantage of this form of binary I/O over the simpler System.IO library is support for serialising more complex data types, using type classes to recursively define binary I/O routines for each component of the type. Instances of I/O may be written by hand, or derived mechanically with DrIFT. Ideally Binary would be derivable by the compiler (is this feasible?).


Proposal 1

  • The simplest implementation option is System.IO, which provides hGetBuf-style I/O. More sophisticated systems can be layered on top, as external libraries.
  • Packed strings, layered over System.IO, are a related interface, and sometimes used for binary I/O of flat data types.

Proposal 2

  • The Binary class is the de-facto standard for more structured data. The origins are described here. Distributed with nhc, and used by GHC to deal with .hi files. Tool support from DrIFT to derive new instances. Flavours include:
  • SerTH is a Binary-alike, which uses Template Haskell to derive serialiser instances for each data type. It's an alternative to using DrIFT (or handwriting) your own Binary instances. Obviously requires TH. Supports serialising cyclic structures
  • ByteStream, a new high-performance serialisation library, using gzip compression.

Pros/Cons? : System.IO


  • System.IO extensions are already in common use, simple to implement
  • More sophisticated binary I/O may be layered on top


  • Possible that the API is not rich enough for many binary I/O requirements, we should strive for more?

Pros/Cons? : Binary


  • The Binary class (particularly as implemented in NewBinary?) is simple to implement and widely used.
  • Binary IO is an oft requested feature, lack of which is sometimes considered a flaw in Haskell98.
  • Difficult to serialise data without this class


  • There is an overlap with the Storable class that isn't exploited
  • Doesn't support cyclic structures
  • Lack of derivability can be annoying