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 [RSS]||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, 0.2.4.8 (info)|
|Dependencies||base (>=4 && <5), bytestring, mtl, semigroups, text, unordered-containers, vector [details]|
|Copyright||IMVU Inc., Chad Austin, Andy Friesen|
|Author||Chad Austin, Andy Friesen|
|Uploaded||by chadaustin at 2022-05-13T20:55:34Z|
|Distributions||LTSHaskell:0.2.4.8, NixOS:0.2.4.8, Stackage:0.2.4.8|
|Downloads||13599 total (55 in the last 30 days)|
|Rating||(no votes yet) [estimated by Bayesian average]|
|Status||Docs available [build log]
Last success reported on 2022-05-13 [all 1 reports]