AllocateStrategy will decide how each BuildStep proceed when previous buffer is not enough.

Helper type to help ghc unpack

BuilderStep is a function that fill buffer under given conditions.

Builder is a monad to help compose BuilderStep. With next BuilderStep continuation, we can do interesting things like perform some action, or interleave the build process.

Notes on IsString instance: Builder ()'s IsString instance use stringModifiedUTF8, which is different from stringUTF8 in that it DOES NOT PROVIDE UTF8 GUARANTEES! :

• \NUL will be written as xC0 x80.
• \xD800 ~ \xDFFF will be encoded in three bytes as normal UTF-8 codepoints.

shortcut to buildBytesWith defaultInitSize.

run Builder with DoubleBuffer strategy, which is suitable for building short bytes.

shortcut to buildBytesListWith defaultChunkSize.

run Builder with InsertChunk strategy, which is suitable for building lazy bytes chunks.

shortcut to buildAndRunWith defaultChunkSize.

run Builder with OneShotAction strategy, which is suitable for doing effects while building.

Write a Bytes.

Ensure that there are at least n many elements available.

write primitive types in host byte order.

write primitive types with little endianess.

write primitive types with big endianess.

Encode string with modified UTF-8 encoding, will be rewritten to a memcpy if possible.

Turn Char into Builder with Modified UTF8 encoding

\NUL is encoded as two bytes C0 80 , \xD800 ~ \xDFFF is encoded as a three bytes normal UTF-8 codepoint.

Turn String into Builder with UTF8 encoding

Illegal codepoints will be written as replacementChars.

This is different from writing string literals builders via OverloadedStrings, because string literals do not provide UTF8 guarantees.

This function will be rewritten into a memcpy if possible, (running a fast UTF-8 validation at runtime first).

Turn Char into Builder with UTF8 encoding

Illegal codepoints will be written as replacementChars.

Turn String into Builder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

Turn Char into Builder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

Turn String into Builder with ASCII8 encoding

Codepoints beyond '\xFF' will be chopped. Note, this encoding is NOT compatible with UTF8 encoding, i.e. bytes written by this builder may not be legal UTF8 encoding bytes.

Turn Char into Builder with ASCII8 encoding

Codepoints beyond '\xFF' will be chopped. Note, this encoding is NOT compatible with UTF8 encoding, i.e. bytes written by this builder may not be legal UTF8 encoding bytes.

Write UTF8 encoded Text using Builder.

Note, if you're trying to write string literals builders, please open OverloadedStrings and use Builders IsString instance, it will be rewritten into a memcpy.

add (...) to original builder.

add {...} to original builder.

add [...] to original builder.

add <...> to original builder.

add "..." to original builder.

add '...' to original builder.

write an ASCII :

write an ASCII ,

Use separator to connect a vector of builders.

import Z.Data.Builder as B
import Z.Data.Text    as T
import Z.Data.Vector  as V

> T.validate . B.buildBytes $ B.intercalateVec "," B.int (V.pack [1,2,3,4] :: V.PrimVector Int)
"1,2,3,4"

Use separator to connect list of builders.

import Z.Data.Builder as B
import Z.Data.Text    as T
import Z.Data.Vector  as V

T.validate . B.buildBytes $ B.intercalateList "," B.int ([1,2,3,4] :: [Int])
"1,2,3,4"