The blaze-builder package

[Tags:bsd3, library, test]

This library provides an implementation of the older blaze-builder interface in terms of the new builder that shipped with bytestring-0.10.4.0

This implementation is mostly intended as a bridge to the new builder, so that code that uses the old interface can interoperate with code that uses the new implementation. Note that no attempt has been made to preserve the old internal modules, so code that has these dependencies cannot use this interface.

New code should, for the most part, use the new interface. However, this module does implement a chunked HTTP encoding, which is not otherwise implemented (yet?) with the new builder.


[Skip to Readme]

Properties

Versions 0.1, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.2.1.0, 0.2.1.1, 0.2.1.2, 0.2.1.3, 0.2.1.4, 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.3.1.0, 0.3.1.1, 0.3.2.0, 0.3.3.0, 0.3.3.1, 0.3.3.2, 0.3.3.3, 0.3.3.4, 0.4.0.0, 0.4.0.1, 0.4.0.2
Change log CHANGES
Dependencies base (==4.*), bytestring (>=0.9 && <1.0), bytestring-builder, deepseq, text (>=0.10 && <1.3) [details]
License BSD3
Copyright (c) 2010-2014 Simon Meier (c) 2010 Jasper Van der Jeugt (c) 2013-2015 Leon P Smith
Author Jasper Van der Jeugt, Simon Meier, Leon P Smith
Maintainer Leon Smith <leon@melding-monads.com>
Stability Experimental
Category Data
Home page http://github.com/lpsmith/blaze-builder
Bug tracker http://github.com/lpsmith/blaze-builder/issues
Source repository head: git clone https://github.com/lpsmith/blaze-builder.git
Uploaded Mon Apr 18 19:48:06 UTC 2016 by LeonSmith
Distributions Arch:0.4.0.2, Debian:0.4.0.1, Fedora:0.3.3.4, FreeBSD:0.4.0.1, LTSHaskell:0.4.0.2, NixOS:0.4.0.2, Stackage:0.4.0.2, Tumbleweed:0.4.0.2
Downloads 192835 total (96 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for blaze-builder

Readme for blaze-builder-0.4.0.2

blaze-builder

Continuous Integration status Hackage page (downloads and API reference)

This library allows to efficiently serialize Haskell values to lazy bytestrings with a large average chunk size. The large average chunk size allows to make good use of cache prefetching in later processing steps (e.g. compression) and reduces the system call overhead when writing the resulting lazy bytestring to a file or sending it over the network.

This library was inspired by the module Data.Binary.Builder provided by the binary package. It was originally developed with the specific needs of the blaze-html package in mind. Since then it has been restructured to serve as a drop-in replacement for Data.Binary.Builder, which it improves upon both in speed as well as expressivity.

To see the improvements in speed, run the throughput benchmark, which measures serialization speeds for writing Word8, Word16, Word32 and Word64 in different endian formats and different chunk sizes, using the command

make bench-throughput

or run the list serialization comparison benchmark

make bench-blaze-vs-binary

Checkout the combinators in the module "Blaze.ByteString.Builder.Write" to see the improvements in expressivity. This module allows to incorporate efficient primitive buffer manipulations as parts of a builder. We use this facility in the 'blaze-html' HTML templating library to allow for the efficient serialization of HTML escaped and UTF-8 encoded characters.