binary: Binary serialisation for Haskell values using lazy ByteStrings

[ bsd3, data, library, parsing ] [ Propose Tags ]

Efficient, pure binary serialisation using lazy ByteStrings. Haskell values may be encoded to and from binary formats, written to disk as binary, or sent over the network. Serialisation speeds of over 1 G/sec have been observed, so this library should be suitable for high performance scenarios.

[Skip to Readme]


Automatic Flags

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


Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Versions [RSS] 0.2, 0.3, 0.4, 0.4.1, 0.4.2, 0.4.3,, 0.4.4, 0.4.5, 0.5,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, (info)
Dependencies array, base (<2.2 || >=3 && <4.7), bytestring (>=0.9 && <0.11), containers [details]
License BSD-3-Clause
Author Lennart Kolmodin <>
Maintainer Lennart Kolmodin, Don Stewart <>
Revised Revision 2 made by phadej at 2020-09-19T07:50:36Z
Category Data, Parsing
Home page
Uploaded by DonaldStewart at 2009-09-16T17:51:40Z
Distributions Arch:, Fedora:
Reverse Dependencies 1106 direct, 13626 indirect [details]
Downloads 195664 total (412 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for binary-

[back to package description]
  binary: efficient, pure binary serialisation using lazy ByteStrings

The 'binary' package provides Data.Binary, containing the Binary class,
and associated methods, for serialising values to and from lazy

A key feature of 'binary' is that the interface is both pure, and efficient.

The 'binary' package is portable to GHC and Hugs.


    runhaskell Setup.lhs configure
    runhaskell Setup.lhs build
    runhaskell Setup.lhs install

    import Data.Binary

and then write an instance of Binary for the type you wish to serialise.
More information in the haddock documentation.


It is possible to mechanically derive new instances of Binary for your
types, if they support the Data and Typeable classes. A script is
provided in tools/derive. Here's an example of its use.

    $ cd binary 
    $ cd tools/derive 

    $ ghci -fglasgow-exts BinaryDerive.hs

    *BinaryDerive> :l Example.hs 

    *Main> deriveM (undefined :: Drinks)

    instance Binary Main.Drinks where
      put (Beer a) = putWord8 0 >> put a
      put Coffee = putWord8 1
      put Tea = putWord8 2
      put EnergyDrink = putWord8 3
      put Water = putWord8 4
      put Wine = putWord8 5
      put Whisky = putWord8 6
      get = do
        tag_ <- getWord8
        case tag_ of
          0 -> get >>= \a -> return (Beer a)
          1 -> return Coffee
          2 -> return Tea
          3 -> return EnergyDrink
          4 -> return Water
          5 -> return Wine
          6 -> return Whisky


    Lennart Kolmodin
    Duncan Coutts
    Don Stewart
    Spencer Janssen
    David Himmelstrup
    Björn Bringert
    Ross Paterson
    Einar Karttunen
    John Meacham
    Ulf Norell
    Tomasz Zielonka
    Stefan Karrmann
    Bryan O'Sullivan
    Florian Weimer