buffer-builder: Library for efficiently building up buffers, one piece at a time
Data.BufferBuilder is an efficient library for incrementally building
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:
State monad, concatenating ByteStrings: 6.98 us
State monad, ByteString Builder: 2.48 us
Crazy explicit RealWorld baton passing with unboxed state: 28.94 us (GHC generated really awful code for this, but see the revision history for the technique)
C + FFI + ReaderT: 1.11 us
Using BufferBuilder is very simple:
import qualified Data.BufferBuilder as BB let byteString = BB.runBufferBuilder $ do BB.appendBS "http" BB.appendChar8 '/' BB.appendBS "//"
|Versions [faq]||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, 0.2.4.5, 0.2.4.6, 0.2.4.7 (info)|
|Dependencies||base (>1 && <1), bytestring, mtl, text, unordered-containers, vector [details]|
|Copyright||IMVU Inc., Chad Austin, Andy Friesen|
|Author||Chad Austin, Andy Friesen|
|Revised||Revision 1 made by HerbertValerioRiedel at Thu Dec 1 18:46:29 UTC 2016|
|Uploaded||by chadaustin at Sun Feb 22 01:29:27 UTC 2015|
|Distributions||LTSHaskell:0.2.4.7, NixOS:0.2.4.7, Stackage:0.2.4.7|
|Downloads||6187 total (172 in the last 30 days)|
|Rating||(no votes yet) [estimated by rule of succession]|
Docs not available [build log]
All reported builds failed as of 2016-12-01 [all 6 reports]
- buffer-builder-0.2.0.0.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
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'.
For package maintainers and hackage trustees