Mason.Builder

Documentation

type Builder = forall s. Buildable s => BuilderFor s

The Builder type. Requires RankNTypes extension

data BuilderFor s

Builder specialised for a backend

Instances

Buildable s => IsString (BuilderFor s)

Defined in Mason.Builder.Internal

Methods

fromString :: String -> BuilderFor s

Semigroup (BuilderFor s)

Defined in Mason.Builder.Internal

Methods

(<>) :: BuilderFor s -> BuilderFor s -> BuilderFor s

sconcat :: NonEmpty (BuilderFor s) -> BuilderFor s

stimes :: Integral b => b -> BuilderFor s -> BuilderFor s

Monoid (BuilderFor a)

Defined in Mason.Builder.Internal

Methods

mempty :: BuilderFor a

mappend :: BuilderFor a -> BuilderFor a -> BuilderFor a

mconcat :: [BuilderFor a] -> BuilderFor a

class Buildable s

This class is used to provide backend-specific operations for running a Builder.

Minimal complete definition

flush, allocate

Instances

Buildable ()

Work with a constant buffer. allocate will always fail.

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor ()

flush :: BuilderFor ()

allocate :: Int -> BuilderFor ()

Buildable StreamingBackend

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor StreamingBackend

flush :: BuilderFor StreamingBackend

allocate :: Int -> BuilderFor StreamingBackend

Buildable PutEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor PutEnv

flush :: BuilderFor PutEnv

allocate :: Int -> BuilderFor PutEnv

Buildable Channel

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor Channel

flush :: BuilderFor Channel

allocate :: Int -> BuilderFor Channel

Buildable GrowingBuffer

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor GrowingBuffer

flush :: BuilderFor GrowingBuffer

allocate :: Int -> BuilderFor GrowingBuffer

Buildable DynamicBackend

Defined in Mason.Builder.Dynamic

Methods

byteString :: ByteString -> BuilderFor DynamicBackend

flush :: BuilderFor DynamicBackend

allocate :: Int -> BuilderFor DynamicBackend

Runners

type StrictByteStringBackend = GrowingBuffer

toStrictByteString :: BuilderFor StrictByteStringBackend -> ByteString

Create a strict ByteString

type LazyByteStringBackend = Channel

toLazyByteString :: BuilderFor LazyByteStringBackend -> ByteString

Create a lazy ByteString. Threaded runtime is required.

type BufferedIOBackend = PutEnv

hPutBuilderLen :: Handle -> BuilderFor BufferedIOBackend -> IO Int

Write a Builder into a handle and obtain the number of bytes written. flush does not imply actual disk operations. Set NoBuffering if you want it to write the content immediately.

hPutBuilder :: Handle -> BuilderFor PutEnv -> IO ()

Put the content of a Builder to a Handle.

sendBuilder :: Socket -> BuilderFor BufferedIOBackend -> IO Int

Write a Builder into a handle and obtain the number of bytes written.

withPopper :: BuilderFor LazyByteStringBackend -> (IO ByteString -> IO a) -> IO a

Use Builder as a <http://hackage.haskell.org/package/http-client-0.7.1/docs/Network-HTTP-Client.html#t:GivesPopper GivesPopper'

data StreamingBackend

Instances

Buildable StreamingBackend

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor StreamingBackend

flush :: BuilderFor StreamingBackend

allocate :: Int -> BuilderFor StreamingBackend

toStreamingBody :: BuilderFor StreamingBackend -> (Builder -> IO ()) -> IO () -> IO ()

Convert a Builder into a StreamingBody.

Primitives

flush :: Buildable s => BuilderFor s

Flush the content of the internal buffer.

Bytes

byteString :: Buildable s => ByteString -> BuilderFor s

Put a ByteString.

lazyByteString :: ByteString -> Builder

Combine chunks of a lazy ByteString

shortByteString :: ShortByteString -> Builder

Copy a ShortByteString to a buffer.

Text

textUtf8 :: Text -> Builder

Encode Text as a UTF-8 byte stream.

encodeUtf8Builder :: Text -> Builder

Encode Text as a UTF-8 byte stream. Synonym for textUtf8.

encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder

Encode Text with a custom escaping function

char7 :: Char -> Builder

Char7 encode a Char.

string7 :: String -> Builder

Char7 encode a String.

char8 :: Char -> Builder

Char8 encode a Char.

string8 :: String -> Builder

Char8 encode a String.

charUtf8 :: Char -> Builder

UTF-8 encode a Char.

stringUtf8 :: String -> Builder

UTF-8 encode a String.

Primitive

storable :: Storable a => a -> Builder

Turn a Storable value into a Builder

int8 :: Int8 -> Builder

Encode a single signed byte as-is.

word8 :: Word8 -> Builder

Encode a single unsigned byte as-is.

int16LE :: Int16 -> Builder

Encode an Int16 in little endian format.

int32LE :: Int32 -> Builder

Encode an Int32 in little endian format.

int64LE :: Int64 -> Builder

Encode an Int64 in little endian format.

word16LE :: Word16 -> Builder

Encode a Word16 in little endian format.

word32LE :: Word32 -> Builder

Encode a Word32 in little endian format.

word64LE :: Word64 -> Builder

Encode a Word64 in little endian format.

floatLE :: Float -> Builder

Encode a Float in little endian format.

doubleLE :: Double -> Builder

Encode a Double in little endian format.

int16BE :: Int16 -> Builder

Encode an Int16 in big endian format.

int32BE :: Int32 -> Builder

Encode an Int32 in big endian format.

int64BE :: Int64 -> Builder

Encode an Int64 in big endian format.

word16BE :: Word16 -> Builder

Encode a Word16 in big endian format.

word32BE :: Word32 -> Builder

Encode a Word32 in big endian format.

word64BE :: Word64 -> Builder

Encode a Word64 in big endian format.

floatBE :: Float -> Builder

Encode a Float in big endian format.

doubleBE :: Double -> Builder

Encode a Double in big endian format.

Numeral

floatDec :: Float -> Builder

Currently slow. Decimal encoding of an IEEE Float.

doubleDec :: Double -> Builder

Decimal encoding of an IEEE Double.

doubleSI

Arguments

:: Int

precision: must be equal or greater than 3

-> Double

-> Builder

Attach an SI prefix so that abs(mantissa) is within [1, 1000). Omits c, d, da and h.

doubleExp

Arguments

:: Int

number of digits in the mantissa

-> Double

-> Builder

Always use exponents

doubleFixed

Arguments

:: Int

decimal points

-> Double

-> Builder

Fixed precision

word8Dec :: Word8 -> Builder

Decimal encoding of a Word8 using the ASCII digits.

word16Dec :: Word16 -> Builder

Decimal encoding of a Word16 using the ASCII digits.

word32Dec :: Word32 -> Builder

Decimal encoding of a Word32 using the ASCII digits.

word64Dec :: Word64 -> Builder

Decimal encoding of a Word64 using the ASCII digits.

wordDec :: Word -> Builder

Decimal encoding of a Word using the ASCII digits.

int8Dec :: Int8 -> Builder

Decimal encoding of an Int8 using the ASCII digits.

e.g.

toLazyByteString (int8Dec 42)   = "42"
toLazyByteString (int8Dec (-1)) = "-1"

int16Dec :: Int16 -> Builder

Decimal encoding of an Int16 using the ASCII digits.

int32Dec :: Int32 -> Builder

Decimal encoding of an Int32 using the ASCII digits.

int64Dec :: Int64 -> Builder

Decimal encoding of an Int64 using the ASCII digits.

intDec :: Int -> Builder

Decimal encoding of an Int using the ASCII digits.

intDecPadded :: Int -> Int -> Builder

intDec with 0 padding

integerDec :: Integer -> Builder

Decimal encoding of an Integer using the ASCII digits. Simon Meier's improved implementation from https://github.com/haskell/bytestring/commit/92f19a5d94761042b44a433d7331107611e4d717

word8Hex :: Word8 -> Builder

Shortest hexadecimal encoding of a Word8 using lower-case characters.

word16Hex :: Word16 -> Builder

Shortest hexadecimal encoding of a Word16 using lower-case characters.

word32Hex :: Word32 -> Builder

Shortest hexadecimal encoding of a Word32 using lower-case characters.

word64Hex :: Word64 -> Builder

Shortest hexadecimal encoding of a Word64 using lower-case characters.

wordHex :: Word -> Builder

Shortest hexadecimal encoding of a Word using lower-case characters.

int8HexFixed :: Int8 -> Builder

Encode a Int8 using 2 nibbles (hexadecimal digits).

int16HexFixed :: Int16 -> Builder

Encode a Int16 using 4 nibbles.

int32HexFixed :: Int32 -> Builder

Encode a Int32 using 8 nibbles.

int64HexFixed :: Int64 -> Builder

Encode a Int64 using 16 nibbles.

word8HexFixed :: Word8 -> Builder

Encode a Word8 using 2 nibbles (hexadecimal digits).

word16HexFixed :: Word16 -> Builder

Encode a Word16 using 4 nibbles.

word32HexFixed :: Word32 -> Builder

Encode a Word32 using 8 nibbles.

word64HexFixed :: Word64 -> Builder

Encode a Word64 using 16 nibbles.

floatHexFixed :: Float -> Builder

Encode an IEEE Float using 8 nibbles.

doubleHexFixed :: Double -> Builder

Encode an IEEE Double using 16 nibbles.

byteStringHex :: ByteString -> Builder

Encode each byte of a ByteString using its fixed-width hex encoding.

lazyByteStringHex :: ByteString -> Builder

Encode each byte of a lazy ByteString using its fixed-width hex encoding.

Variable-length encoding

intVLQ :: Int -> Builder

Signed VLQ encoding (the first bit is a sign)

intVLQBP :: BoundedPrim Int

wordVLQ :: Word -> Builder

Unsigned VLQ encoding

wordVLQBP :: BoundedPrim Word

prefixVarInt :: Word -> Builder

Encode a Word in PrefixVarInt

prefixVarIntBP :: BoundedPrim Word

Combinators

intersperse :: Buildable e => BuilderFor e -> [BuilderFor e] -> BuilderFor e

unwords :: Buildable e => [BuilderFor e] -> BuilderFor e

unlines :: Buildable e => [BuilderFor e] -> BuilderFor e

viaShow :: Show a => a -> Builder

Turn a value into a Builder using the Show instance.

Advanced

paddedBoundedPrim

Arguments

:: Word8

filler

-> Int

pad if shorter than this

-> BoundedPrim a

-> a

-> Builder

zeroPaddedBoundedPrim :: Int -> BoundedPrim a -> a -> Builder

primFixed :: FixedPrim a -> a -> Builder

Use FixedPrim

primBounded :: BoundedPrim a -> a -> Builder

Use BoundedPrim

lengthPrefixedWithin

Arguments

:: Int

maximum length

-> BoundedPrim Int

prefix encoder

-> BuilderFor ()

-> Builder

Run a builder within a buffer and prefix it by the length.