Copyright	(c) Fumiaki Kinoshita 2019-
License	BSD3
Maintainer	Fumiaki Kinoshita <fumiexcel@gmail.com>
Safe Haskell	None
Language	Haskell2010

Mason.Builder

Contents

Runners
Primitives
Bytes
Text
Primitive
Numeral
Variable-length encoding
Combinators
Advanced

Description

Synopsis

type Builder = forall s. Buildable s => BuilderFor s
data BuilderFor s
class Buildable s
type StrictByteStringBackend = GrowingBuffer
toStrictByteString :: BuilderFor StrictByteStringBackend -> ByteString
type LazyByteStringBackend = Channel
toLazyByteString :: BuilderFor LazyByteStringBackend -> ByteString
type BufferedIOBackend = PutEnv
hPutBuilderLen :: Handle -> BuilderFor BufferedIOBackend -> IO Int
hPutBuilder :: Handle -> BuilderFor PutEnv -> IO ()
sendBuilder :: Socket -> BuilderFor BufferedIOBackend -> IO Int
withPopper :: BuilderFor LazyByteStringBackend -> (IO ByteString -> IO a) -> IO a
data StreamingBackend
toStreamingBody :: BuilderFor StreamingBackend -> (Builder -> IO ()) -> IO () -> IO ()
flush :: Buildable s => BuilderFor s
byteString :: Buildable s => ByteString -> BuilderFor s
lazyByteString :: ByteString -> Builder
shortByteString :: ShortByteString -> Builder
textUtf8 :: Text -> Builder
encodeUtf8Builder :: Text -> Builder
encodeUtf8BuilderEscaped :: Buildable s => BoundedPrim Word8 -> Text -> BuilderFor s
char7 :: Char -> Builder
string7 :: String -> Builder
char8 :: Char -> Builder
string8 :: String -> Builder
charUtf8 :: Char -> Builder
stringUtf8 :: Buildable s => String -> BuilderFor s
storable :: Storable a => a -> Builder
int8 :: Int8 -> Builder
word8 :: Word8 -> Builder
int16LE :: Int16 -> Builder
int32LE :: Int32 -> Builder
int64LE :: Int64 -> Builder
word16LE :: Word16 -> Builder
word32LE :: Word32 -> Builder
word64LE :: Word64 -> Builder
floatLE :: Float -> Builder
doubleLE :: Double -> Builder
int16BE :: Int16 -> Builder
int32BE :: Int32 -> Builder
int64BE :: Int64 -> Builder
word16BE :: Word16 -> Builder
word32BE :: Word32 -> Builder
word64BE :: Word64 -> Builder
floatBE :: Float -> Builder
doubleBE :: Double -> Builder
floatDec :: Float -> Builder
doubleDec :: Double -> Builder
doubleSI :: Int -> Double -> Builder
doubleExp :: Int -> Double -> Builder
doubleFixed :: Int -> Double -> Builder
word8Dec :: Word8 -> Builder
word16Dec :: Word16 -> Builder
word32Dec :: Word32 -> Builder
word64Dec :: Word64 -> Builder
wordDec :: Word -> Builder
int8Dec :: Int8 -> Builder
int16Dec :: Int16 -> Builder
int32Dec :: Int32 -> Builder
int64Dec :: Int64 -> Builder
intDec :: Int -> Builder
intDecPadded :: Int -> Int -> Builder
integerDec :: Integer -> Builder
word8Hex :: Word8 -> Builder
word16Hex :: Word16 -> Builder
word32Hex :: Word32 -> Builder
word64Hex :: Word64 -> Builder
wordHex :: Word -> Builder
int8HexFixed :: Int8 -> Builder
int16HexFixed :: Int16 -> Builder
int32HexFixed :: Int32 -> Builder
int64HexFixed :: Int64 -> Builder
word8HexFixed :: Word8 -> Builder
word16HexFixed :: Word16 -> Builder
word32HexFixed :: Word32 -> Builder
word64HexFixed :: Word64 -> Builder
floatHexFixed :: Float -> Builder
doubleHexFixed :: Double -> Builder
byteStringHex :: ByteString -> Builder
lazyByteStringHex :: ByteString -> Builder
intVLQ :: Int -> Builder
intVLQBP :: BoundedPrim Int
wordVLQ :: Word -> Builder
wordVLQBP :: BoundedPrim Word
prefixVarInt :: Word -> Builder
prefixVarIntBP :: BoundedPrim Word
intersperse :: (Foldable f, Buildable e) => BuilderFor e -> f (BuilderFor e) -> BuilderFor e
unwords :: (Foldable f, Buildable e) => f (BuilderFor e) -> BuilderFor e
unlines :: (Foldable f, Buildable e) => f (BuilderFor e) -> BuilderFor e
viaShow :: Show a => a -> Builder
paddedBoundedPrim :: Word8 -> Int -> BoundedPrim a -> a -> Builder
zeroPaddedBoundedPrim :: Int -> BoundedPrim a -> a -> Builder
primFixed :: Buildable s => FixedPrim a -> a -> BuilderFor s
primBounded :: Buildable s => BoundedPrim a -> a -> BuilderFor s
lengthPrefixedWithin :: Int -> BoundedPrim Int -> BuilderFor () -> Builder

Documentation

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

The Builder type. Requires RankNTypes extension

data BuilderFor s Source #

Builder specialised for a backend

Instances

Instances details

Buildable s => IsString (BuilderFor s) Source #
Instance details Defined in Mason.Builder.Internal Methods fromString :: String -> BuilderFor s #
Semigroup (BuilderFor s) Source #
Instance details 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) Source #
Instance details Defined in Mason.Builder.Internal Methods mempty :: BuilderFor a # mappend :: BuilderFor a -> BuilderFor a -> BuilderFor a # mconcat :: [BuilderFor a] -> BuilderFor a #

class Buildable s Source #

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

Minimal complete definition

flush, allocate

Instances

Instances details

Buildable () Source #	Work with a constant buffer. `allocate` will always fail.
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor () Source # flush :: BuilderFor () Source # allocate :: Int -> BuilderFor () Source #
Buildable StreamingBackend Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor StreamingBackend Source # flush :: BuilderFor StreamingBackend Source # allocate :: Int -> BuilderFor StreamingBackend Source #
Buildable PutEnv Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor PutEnv Source # flush :: BuilderFor PutEnv Source # allocate :: Int -> BuilderFor PutEnv Source #
Buildable Channel Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor Channel Source # flush :: BuilderFor Channel Source # allocate :: Int -> BuilderFor Channel Source #
Buildable GrowingBuffer Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor GrowingBuffer Source # flush :: BuilderFor GrowingBuffer Source # allocate :: Int -> BuilderFor GrowingBuffer Source #
Buildable DynamicBackend Source #
Instance details Defined in Mason.Builder.Dynamic Methods byteString :: ByteString -> BuilderFor DynamicBackend Source # flush :: BuilderFor DynamicBackend Source # allocate :: Int -> BuilderFor DynamicBackend Source #

Runners

type StrictByteStringBackend = GrowingBuffer Source #

toStrictByteString :: BuilderFor StrictByteStringBackend -> ByteString Source #

Create a strict ByteString

type LazyByteStringBackend = Channel Source #

toLazyByteString :: BuilderFor LazyByteStringBackend -> ByteString Source #

Create a lazy ByteString. Threaded runtime is required.

type BufferedIOBackend = PutEnv Source #

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

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 () Source #

Put the content of a Builder to a Handle.

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

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

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

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

data StreamingBackend Source #

Instances

Instances details

Buildable StreamingBackend Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor StreamingBackend Source # flush :: BuilderFor StreamingBackend Source # allocate :: Int -> BuilderFor StreamingBackend Source #

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

Convert a Builder into a StreamingBody.

Primitives

flush :: Buildable s => BuilderFor s Source #

Flush the content of the internal buffer.

Bytes

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

Put a ByteString.

lazyByteString :: ByteString -> Builder Source #

Combine chunks of a lazy ByteString

shortByteString :: ShortByteString -> Builder Source #

Copy a ShortByteString to a buffer.

Text

textUtf8 :: Text -> Builder Source #

Encode Text as a UTF-8 byte stream.

encodeUtf8Builder :: Text -> Builder Source #

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

encodeUtf8BuilderEscaped :: Buildable s => BoundedPrim Word8 -> Text -> BuilderFor s Source #

Encode Text with a custom escaping function

char7 :: Char -> Builder Source #

Char7 encode a Char.

string7 :: String -> Builder Source #

Char7 encode a String.

char8 :: Char -> Builder Source #

Char8 encode a Char.

string8 :: String -> Builder Source #

Char8 encode a String.

charUtf8 :: Char -> Builder Source #

UTF-8 encode a Char.

stringUtf8 :: Buildable s => String -> BuilderFor s Source #

UTF-8 encode a String.

Primitive

storable :: Storable a => a -> Builder Source #

Turn a Storable value into a Builder

int8 :: Int8 -> Builder Source #

Encode a single signed byte as-is.

word8 :: Word8 -> Builder Source #

Encode a single unsigned byte as-is.

int16LE :: Int16 -> Builder Source #

Encode an Int16 in little endian format.

int32LE :: Int32 -> Builder Source #

Encode an Int32 in little endian format.

int64LE :: Int64 -> Builder Source #

Encode an Int64 in little endian format.

word16LE :: Word16 -> Builder Source #

Encode a Word16 in little endian format.

word32LE :: Word32 -> Builder Source #

Encode a Word32 in little endian format.

word64LE :: Word64 -> Builder Source #

Encode a Word64 in little endian format.

floatLE :: Float -> Builder Source #

Encode a Float in little endian format.

doubleLE :: Double -> Builder Source #

Encode a Double in little endian format.

int16BE :: Int16 -> Builder Source #

Encode an Int16 in big endian format.

int32BE :: Int32 -> Builder Source #

Encode an Int32 in big endian format.

int64BE :: Int64 -> Builder Source #

Encode an Int64 in big endian format.

word16BE :: Word16 -> Builder Source #

Encode a Word16 in big endian format.

word32BE :: Word32 -> Builder Source #

Encode a Word32 in big endian format.

word64BE :: Word64 -> Builder Source #

Encode a Word64 in big endian format.

floatBE :: Float -> Builder Source #

Encode a Float in big endian format.

doubleBE :: Double -> Builder Source #

Encode a Double in big endian format.

Numeral

floatDec :: Float -> Builder Source #

Currently slow. Decimal encoding of an IEEE Float.

doubleDec :: Double -> Builder Source #

Decimal encoding of an IEEE Double.

doubleSI Source #

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 Source #

Arguments

:: Int	number of digits in the mantissa
-> Double
-> Builder

Always use exponents

doubleFixed Source #

Arguments

:: Int	decimal points
-> Double
-> Builder

Fixed precision

word8Dec :: Word8 -> Builder Source #

Decimal encoding of a Word8 using the ASCII digits.

word16Dec :: Word16 -> Builder Source #

Decimal encoding of a Word16 using the ASCII digits.

word32Dec :: Word32 -> Builder Source #

Decimal encoding of a Word32 using the ASCII digits.

word64Dec :: Word64 -> Builder Source #

Decimal encoding of a Word64 using the ASCII digits.

wordDec :: Word -> Builder Source #

Decimal encoding of a Word using the ASCII digits.

int8Dec :: Int8 -> Builder Source #

Decimal encoding of an Int8 using the ASCII digits.

e.g.

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

int16Dec :: Int16 -> Builder Source #

Decimal encoding of an Int16 using the ASCII digits.

int32Dec :: Int32 -> Builder Source #

Decimal encoding of an Int32 using the ASCII digits.

int64Dec :: Int64 -> Builder Source #

Decimal encoding of an Int64 using the ASCII digits.

intDec :: Int -> Builder Source #

Decimal encoding of an Int using the ASCII digits.

intDecPadded :: Int -> Int -> Builder Source #

intDec with 0 padding

integerDec :: Integer -> Builder Source #

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 Source #

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

word16Hex :: Word16 -> Builder Source #

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

word32Hex :: Word32 -> Builder Source #

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

word64Hex :: Word64 -> Builder Source #

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

wordHex :: Word -> Builder Source #

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

int8HexFixed :: Int8 -> Builder Source #

Encode a Int8 using 2 nibbles (hexadecimal digits).

int16HexFixed :: Int16 -> Builder Source #

Encode a Int16 using 4 nibbles.

int32HexFixed :: Int32 -> Builder Source #

Encode a Int32 using 8 nibbles.

int64HexFixed :: Int64 -> Builder Source #

Encode a Int64 using 16 nibbles.

word8HexFixed :: Word8 -> Builder Source #

Encode a Word8 using 2 nibbles (hexadecimal digits).

word16HexFixed :: Word16 -> Builder Source #

Encode a Word16 using 4 nibbles.

word32HexFixed :: Word32 -> Builder Source #

Encode a Word32 using 8 nibbles.

word64HexFixed :: Word64 -> Builder Source #

Encode a Word64 using 16 nibbles.

floatHexFixed :: Float -> Builder Source #

Encode an IEEE Float using 8 nibbles.

doubleHexFixed :: Double -> Builder Source #

Encode an IEEE Double using 16 nibbles.

byteStringHex :: ByteString -> Builder Source #

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

lazyByteStringHex :: ByteString -> Builder Source #

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

Variable-length encoding

intVLQ :: Int -> Builder Source #

Signed VLQ encoding (the first bit is a sign)

intVLQBP :: BoundedPrim Int Source #

wordVLQ :: Word -> Builder Source #

Unsigned VLQ encoding

wordVLQBP :: BoundedPrim Word Source #

prefixVarInt :: Word -> Builder Source #

Encode a Word in PrefixVarInt

prefixVarIntBP :: BoundedPrim Word Source #

Combinators

intersperse :: (Foldable f, Buildable e) => BuilderFor e -> f (BuilderFor e) -> BuilderFor e Source #

unwords :: (Foldable f, Buildable e) => f (BuilderFor e) -> BuilderFor e Source #

unlines :: (Foldable f, Buildable e) => f (BuilderFor e) -> BuilderFor e Source #

viaShow :: Show a => a -> Builder Source #

Turn a value into a Builder using the Show instance.

Advanced

paddedBoundedPrim Source #

Arguments

:: Word8	filler
-> Int	pad if shorter than this
-> BoundedPrim a
-> a
-> Builder

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

primFixed :: Buildable s => FixedPrim a -> a -> BuilderFor s Source #

Use FixedPrim

primBounded :: Buildable s => BoundedPrim a -> a -> BuilderFor s Source #

Use BoundedPrim

lengthPrefixedWithin Source #

Arguments

:: Int	maximum length
-> BoundedPrim Int	prefix encoder
-> BuilderFor ()
-> Builder

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