Z.Data.Builder

A Builder records a buffer writing function, which can be mappend in O(1) via composition. This module provides many functions to turn basic data types into Builders, which can used to build strict Bytes or list of Bytes chunks.

Builder type

data Builder a

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.

Instances

Monad Builder

Defined in Z.Data.Builder.Base

Methods

(>>=) :: Builder a -> (a -> Builder b) -> Builder b

(>>) :: Builder a -> Builder b -> Builder b

return :: a -> Builder a

fail :: String -> Builder a

Functor Builder

Defined in Z.Data.Builder.Base

Methods

fmap :: (a -> b) -> Builder a -> Builder b

(<$) :: a -> Builder b -> Builder a

Applicative Builder

Defined in Z.Data.Builder.Base

Methods

pure :: a -> Builder a

(<*>) :: Builder (a -> b) -> Builder a -> Builder b

liftA2 :: (a -> b -> c) -> Builder a -> Builder b -> Builder c

(*>) :: Builder a -> Builder b -> Builder b

(<*) :: Builder a -> Builder b -> Builder a

Show (Builder a)

Defined in Z.Data.Builder.Base

Methods

showsPrec :: Int -> Builder a -> ShowS

show :: Builder a -> String

showList :: [Builder a] -> ShowS

a ~ () => IsString (Builder a)

This instance simple write literals' bytes into buffer, which is different from stringUTF8 in that it DOES NOT PROVIDE UTF8 GUARANTEES! :

Defined in Z.Data.Builder.Base

Methods

fromString :: String -> Builder a

Semigroup (Builder ())

Defined in Z.Data.Builder.Base

Methods

(<>) :: Builder () -> Builder () -> Builder ()

sconcat :: NonEmpty (Builder ()) -> Builder ()

stimes :: Integral b => b -> Builder () -> Builder ()

Monoid (Builder ())

Defined in Z.Data.Builder.Base

Methods

mempty :: Builder ()

mappend :: Builder () -> Builder () -> Builder ()

mconcat :: [Builder ()] -> Builder ()

Arbitrary (Builder ())

Defined in Z.Data.Builder.Base

Methods

arbitrary :: Gen (Builder ())

shrink :: Builder () -> [Builder ()]

CoArbitrary (Builder ())

Defined in Z.Data.Builder.Base

Methods

coarbitrary :: Builder () -> Gen b -> Gen b

append :: Builder a -> Builder b -> Builder b

Running builders

buildBytes :: Builder a -> Bytes

shortcut to buildBytesWith defaultInitSize.

buildBytesWith :: Int -> Builder a -> Bytes

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

buildBytesList :: Builder a -> [Bytes]

shortcut to buildBytesListWith defaultChunkSize.

buildBytesListWith :: Int -> Int -> Builder a -> [Bytes]

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

buildAndRun :: (Bytes -> IO ()) -> Builder a -> IO ()

shortcut to buildAndRunWith defaultChunkSize.

buildAndRunWith :: Int -> (Bytes -> IO ()) -> Builder a -> IO ()

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

Basic buiders

bytes :: Bytes -> Builder ()

Write a Bytes.

ensureN :: Int -> Builder ()

Ensure that there are at least n many elements available.

atMost

Arguments

:: Int

size bound

-> (forall s. MutablePrimArray s Word8 -> Int -> ST s Int)

the writer which pure a new offset for next write

-> Builder ()

writeN

Arguments

:: Int

size bound

-> (forall s. MutablePrimArray s Word8 -> Int -> ST s ())

the writer which pure a new offset for next write

-> Builder ()

Pritimive builders

encodePrim :: forall a. Unaligned a => a -> Builder ()

write primitive types in host byte order.

encodePrimLE :: forall a. Unaligned (LE a) => a -> Builder ()

write primitive types with little endianess.

encodePrimBE :: forall a. Unaligned (BE a) => a -> Builder ()

write primitive types with big endianess.

More builders

stringModifiedUTF8 :: String -> Builder ()

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

charModifiedUTF8 :: Char -> Builder ()

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.

stringUTF8 :: String -> Builder ()

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).

charUTF8 :: Char -> Builder ()

Turn Char into Builder with UTF8 encoding

Illegal codepoints will be written as replacementChars.

string7 :: String -> Builder ()

Turn String into Builder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

char7 :: Char -> Builder ()

Turn Char into Builder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

string8 :: String -> Builder ()

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.

char8 :: Char -> Builder ()

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.

text :: Text -> Builder ()

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.

Numeric builders

Integral type formatting

data IFormat

Integral formatting options.

Constructors

IFormat

Fields

• width :: Int

  total width, only effective with padding options

• padding :: Padding

  padding options

• posSign :: Bool

  show + when the number is positive

Instances

Eq IFormat

Defined in Z.Data.Builder.Numeric

Methods

(==) :: IFormat -> IFormat -> Bool

(/=) :: IFormat -> IFormat -> Bool

Ord IFormat

Defined in Z.Data.Builder.Numeric

Methods

compare :: IFormat -> IFormat -> Ordering

(<) :: IFormat -> IFormat -> Bool

(<=) :: IFormat -> IFormat -> Bool

(>) :: IFormat -> IFormat -> Bool

(>=) :: IFormat -> IFormat -> Bool

max :: IFormat -> IFormat -> IFormat

min :: IFormat -> IFormat -> IFormat

Show IFormat

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> IFormat -> ShowS

show :: IFormat -> String

showList :: [IFormat] -> ShowS

Arbitrary IFormat

Defined in Z.Data.Builder.Numeric

Methods

arbitrary :: Gen IFormat

shrink :: IFormat -> [IFormat]

CoArbitrary IFormat

Defined in Z.Data.Builder.Numeric

Methods

coarbitrary :: IFormat -> Gen b -> Gen b

defaultIFormat :: IFormat

defaultIFormat = IFormat 0 NoPadding False

data Padding

Constructors

NoPadding

RightSpacePadding

LeftSpacePadding

ZeroPadding

Instances

Enum Padding

Defined in Z.Data.Builder.Numeric

Methods

succ :: Padding -> Padding

pred :: Padding -> Padding

toEnum :: Int -> Padding

fromEnum :: Padding -> Int

enumFrom :: Padding -> [Padding]

enumFromThen :: Padding -> Padding -> [Padding]

enumFromTo :: Padding -> Padding -> [Padding]

enumFromThenTo :: Padding -> Padding -> Padding -> [Padding]

Eq Padding

Defined in Z.Data.Builder.Numeric

Methods

(==) :: Padding -> Padding -> Bool

(/=) :: Padding -> Padding -> Bool

Ord Padding

Defined in Z.Data.Builder.Numeric

Methods

compare :: Padding -> Padding -> Ordering

(<) :: Padding -> Padding -> Bool

(<=) :: Padding -> Padding -> Bool

(>) :: Padding -> Padding -> Bool

(>=) :: Padding -> Padding -> Bool

max :: Padding -> Padding -> Padding

min :: Padding -> Padding -> Padding

Show Padding

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> Padding -> ShowS

show :: Padding -> String

showList :: [Padding] -> ShowS

Arbitrary Padding

Defined in Z.Data.Builder.Numeric

Methods

arbitrary :: Gen Padding

shrink :: Padding -> [Padding]

CoArbitrary Padding

Defined in Z.Data.Builder.Numeric

Methods

coarbitrary :: Padding -> Gen b -> Gen b

int :: (Integral a, Bounded a) => a -> Builder ()

int = intWith defaultIFormat

intWith :: (Integral a, Bounded a) => IFormat -> a -> Builder ()

Format a Bounded Integral type like Int or Word16 into decimal ASCII digits.

integer :: Integer -> Builder ()

Format a Integer into decimal ASCII digits.

Fixded size hexidecimal formatting

hex :: forall a. (FiniteBits a, Integral a) => a -> Builder ()

Format a FiniteBits Integral type into hex nibbles.

heX :: forall a. (FiniteBits a, Integral a) => a -> Builder ()

The UPPERCASED version of hex.

IEEE float formating

data FFormat

Control the rendering of floating point numbers.

Constructors

Exponent

Scientific notation (e.g. 2.3e123).

Fixed

Standard decimal notation.

Generic

Use decimal notation for values between 0.1 and 9,999,999, and scientific notation otherwise.

Instances

Enum FFormat

Defined in Z.Data.Builder.Numeric

Methods

succ :: FFormat -> FFormat

pred :: FFormat -> FFormat

toEnum :: Int -> FFormat

fromEnum :: FFormat -> Int

enumFrom :: FFormat -> [FFormat]

enumFromThen :: FFormat -> FFormat -> [FFormat]

enumFromTo :: FFormat -> FFormat -> [FFormat]

enumFromThenTo :: FFormat -> FFormat -> FFormat -> [FFormat]

Read FFormat

Defined in Z.Data.Builder.Numeric

Methods

readsPrec :: Int -> ReadS FFormat

readList :: ReadS [FFormat]

readPrec :: ReadPrec FFormat

readListPrec :: ReadPrec [FFormat]

Show FFormat

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> FFormat -> ShowS

show :: FFormat -> String

showList :: [FFormat] -> ShowS

double :: Double -> Builder ()

Decimal encoding of an IEEE Double.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

doubleWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Double

-> Builder ()

Format double-precision float using drisu3 with dragon4 fallback.

float :: Float -> Builder ()

Decimal encoding of an IEEE Float.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

floatWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Float

-> Builder ()

Format single-precision float using drisu3 with dragon4 fallback.

scientific :: Scientific -> Builder ()

A Builder which renders a scientific number to full precision, using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

scientificWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Scientific

-> Builder ()

Like scientific but provides rendering options.

Builder helpers

paren :: Builder () -> Builder ()

add {...} to original builder.

curly :: Builder () -> Builder ()

add {...} to original builder.

square :: Builder () -> Builder ()

add [...] to original builder.

angle :: Builder () -> Builder ()

add ... to original builder.

quotes :: Builder () -> Builder ()

add "..." to original builder.

squotes :: Builder () -> Builder ()

add ... to original builder.

colon :: Builder ()

write an ASCII :

comma :: Builder ()

write an ASCII ,

intercalateVec

Arguments

:: Vec v a

=> Builder ()

the seperator

-> (a -> Builder ())

value formatter

-> v a

value vector

-> Builder ()

Use separator to connect a vector of builders.

intercalateList

Arguments

:: Builder ()

the seperator

-> (a -> Builder ())

value formatter

-> [a]

value list

-> Builder ()

Use separator to connect list of builders.