Hackage :: [Package]

blaze-builder: Efficient buffered output.

[ bsd3, data, library ] [ Propose Tags ] [ Report a vulnerability ]

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]

Downloads

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

Candidates

Versions [RSS] 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, 0.4.1.0, 0.4.2.1, 0.4.2.2, 0.4.2.3
Change log CHANGES
Dependencies base (>=4 && <4.11), bytestring (>=0.10.4 && <0.11), bytestring-builder, deepseq, text (>=0.10 && <1.3) [details]
License BSD-3-Clause
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>
Revised Revision 3 made by phadej at 2020-09-19T13:40:57Z
Category Data
Home page http://github.com/lpsmith/blaze-builder
Bug tracker http://github.com/lpsmith/blaze-builder/issues
Source repo head: git clone https://github.com/meiersi/blaze-builder.git
Uploaded by LeonSmith at 2015-02-12T10:04:37Z
Distributions Arch:0.4.2.3, Debian:0.4.1.0, Fedora:0.4.2.2, FreeBSD:0.4.0.1, LTSHaskell:0.4.2.3, NixOS:0.4.2.3, Stackage:0.4.2.3, openSUSE:0.4.2.3
Reverse Dependencies 285 direct, 7864 indirect [details]
Downloads 346667 total (392 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-02-12 [all 1 reports]

Readme for blaze-builder-0.4.0.0

[back to package description]

blaze-builder

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.