Mason.Builder.Internal

Documentation

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

The Builder type. Requires RankNTypes extension

newtype BuilderFor s

Builder specialised for a backend

Constructors

RawBuilder

Fields

• unRawBuilder :: s -> BState -> BState

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

type BState = (# Addr#, Addr#, State# RealWorld #)

class Buildable s where

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

Minimal complete definition

flush, allocate

Methods

byteString :: ByteString -> BuilderFor s

Put a ByteString.

flush :: BuilderFor s

Flush the content of the internal buffer.

allocate :: Int -> BuilderFor s

Allocate a buffer with at least the given length.

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

newtype GrowingBuffer

Constructors

GrowingBuffer (IORef (ForeignPtr Word8))

Instances

Buildable GrowingBuffer

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor GrowingBuffer

flush :: BuilderFor GrowingBuffer

allocate :: Int -> BuilderFor GrowingBuffer

data Buffer

Buffer pointers

Constructors

Buffer

Fields

• bEnd :: !(Ptr Word8)

  end of the buffer (next to the last byte)

• bCur :: !(Ptr Word8)

  current position

pattern Builder :: (s -> Buffer -> IO Buffer) -> BuilderFor s

unBuilder :: BuilderFor s -> s -> Buffer -> IO Buffer

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

Copy a ByteString to a buffer.

shortByteString :: ShortByteString -> Builder

Copy a ShortByteString to a buffer.

type StrictByteStringBackend = GrowingBuffer

toStrictByteString :: BuilderFor StrictByteStringBackend -> ByteString

Create a strict ByteString

data Channel

Constructors

Channel

Fields

• chResp :: !(MVar ByteString)
• chBuffer :: !(IORef (ForeignPtr Word8))

Instances

Buildable Channel

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor Channel

flush :: BuilderFor Channel

allocate :: Int -> BuilderFor Channel

type LazyByteStringBackend = Channel

toLazyByteString :: BuilderFor LazyByteStringBackend -> ByteString

Create a lazy ByteString. Threaded runtime is required.

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

Constructors

StreamingBackend

Fields

• sePush :: !(ByteString -> IO ())
• seBuffer :: !(IORef (ForeignPtr Word8))

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.

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

UTF-8 encode a String.

lengthPrefixedWithin

Arguments

:: Int

maximum length

-> BoundedPrim Int

prefix encoder

-> BuilderFor ()

-> Builder

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

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

Use BoundedPrim

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

Use FixedPrim

primMapListFixed :: (Foldable t, Buildable s) => FixedPrim a -> t a -> BuilderFor s

primMapListBounded :: Buildable s => BoundedPrim a -> [a] -> BuilderFor s

primMapByteStringFixed :: Buildable s => FixedPrim Word8 -> ByteString -> BuilderFor s

primMapLazyByteStringFixed :: Buildable s => FixedPrim Word8 -> ByteString -> BuilderFor s

data PutEnv

Environment for handle output

Constructors

PutEnv

Fields

• peThreshold :: !Int
• pePut :: !(Ptr Word8 -> Ptr Word8 -> IO ())

  takes a pointer range and returns the number of bytes written

• peBuffer :: !(IORef (ForeignPtr Word8))
• peTotal :: !(IORef Int)

Instances

Buildable PutEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor PutEnv

flush :: BuilderFor PutEnv

allocate :: Int -> BuilderFor PutEnv

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.

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

Encode Text with a custom escaping function

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

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

cstring :: Ptr Word8 -> Builder

cstringUtf8 :: Ptr Word8 -> Builder

withPtr

Arguments

:: Buildable s

=> Int

number of bytes to allocate (if needed)

-> (Ptr Word8 -> IO (Ptr Word8))

return a next pointer after writing

-> BuilderFor s

Construct a Builder from a "poke" function.

storable :: Storable a => a -> Builder

Turn a Storable value into a Builder

paddedBoundedPrim

Arguments

:: Word8

filler

-> Int

pad if shorter than this

-> BoundedPrim a

-> a

-> Builder

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

Internal

ensure :: Int -> (Buffer -> IO Buffer) -> Builder

Ensure that the given number of bytes is available in the buffer. Subject to semigroup fusion

allocateConstant :: (s -> IORef (ForeignPtr Word8)) -> Int -> BuilderFor s

Allocate a new buffer.

withGrisu3 :: Double -> IO r -> (Ptr Word8 -> Int -> Int -> IO r) -> IO r

Decimal encoding of a positive Double.

withGrisu3Rounded :: Int -> Double -> (Ptr Word8 -> Int -> Int -> IO r) -> IO r

roundDigit

Arguments

:: Int

precision

-> Int

available digits

-> Ptr Word8

content

-> IO Bool

Round up to the supplied precision inplace.