The buffer-builder package

[Tags:benchmark, bsd3, library, test]

Data.BufferBuilder is an efficient library for incrementally building up ByteStrings, one chunk at a time. Early benchmarks show it is over twice as fast as ByteString Builder, primarily because BufferBuilder is built upon an ST-style restricted monad and mutable state instead of ByteString Builder's monoidal AST.

Internally, BufferBuilder is backed by a few C functions. Examination of GHC's output shows nearly optimal code generation with no intermediate thunks -- and thus, continuation passing and its associated indirect jumps and stack traffic only occur when BufferBuilder is asked to append a non-strict ByteString.

I benchmarked four approaches with a URL encoding benchmark:

Using BufferBuilder is very simple:

 import qualified Data.BufferBuilder as BB

 let byteString = BB.runBufferBuilder $ do
       BB.appendBS "http"
       BB.appendChar8 '/'
       BB.appendBS "//"

This package also provides Data.BufferBuilder.Utf8 for generating UTF-8 buffers and Data.BufferBuilder.Json for encoding data structures into JSON.

Properties

Versions 0.1.0.0, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.2.1.0, 0.2.2.0, 0.2.2.1, 0.2.2.2, 0.2.3.0, 0.2.4.0, 0.2.4.1, 0.2.4.2, 0.2.4.3, 0.2.4.4 (info)
Change log changelog.md
Dependencies base (==4.*), bytestring, mtl, text, unordered-containers, vector [details]
License BSD3
Copyright IMVU Inc., Chad Austin, Andy Friesen
Author Chad Austin, Andy Friesen
Maintainer chad@chadaustin.me
Category Data
Home page https://github.com/chadaustin/buffer-builder
Uploaded Thu Dec 1 16:35:06 UTC 2016 by chadaustin
Distributions LTSHaskell:0.2.4.4, NixOS:0.2.4.4, Tumbleweed:0.2.4.4
Downloads 1772 total (27 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2016-12-01 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees