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

Builder

Fields

• unBuilder :: s -> Buffer -> IO Buffer

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 where

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

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 SocketEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor SocketEnv

flush :: BuilderFor SocketEnv

allocate :: Int -> BuilderFor SocketEnv

Buildable PutBuilderEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor PutBuilderEnv

flush :: BuilderFor PutBuilderEnv

allocate :: Int -> BuilderFor PutBuilderEnv

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

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

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

Copy a ByteString to a buffer.

shortByteString :: ShortByteString -> Builder

Copy a ShortByteString to a buffer.

toStrictByteString :: BuilderFor GrowingBuffer -> 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

toLazyByteString :: BuilderFor Channel -> ByteString

Create a lazy ByteString. Threaded runtime is required.

stringUtf8 :: String -> Builder

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 :: BoundedPrim a -> a -> Builder

Use BoundedPrim

primFixed :: FixedPrim a -> a -> Builder

Use FixedPrim

primMapListFixed :: FixedPrim a -> [a] -> Builder

primMapListBounded :: BoundedPrim a -> [a] -> Builder

primMapByteStringFixed :: FixedPrim Word8 -> ByteString -> Builder

primMapLazyByteStringFixed :: FixedPrim Word8 -> ByteString -> Builder

hPutBuilderLen :: Handle -> BuilderFor PutBuilderEnv -> 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.

data PutBuilderEnv

Environemnt for handle output

Constructors

PBE

Fields

• pbHandle :: !Handle
• pbBuffer :: !(IORef (ForeignPtr Word8))
• pbTotal :: !(IORef Int)

Instances

Buildable PutBuilderEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor PutBuilderEnv

flush :: BuilderFor PutBuilderEnv

allocate :: Int -> BuilderFor PutBuilderEnv

encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder

Encode Text with a custom escaping function

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

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

data SocketEnv

Environemnt for socket output

Constructors

SE

Fields

• seSocket :: !Socket
• seBuffer :: !(IORef (ForeignPtr Word8))
• seCounter :: !(IORef Int)

Instances

Buildable SocketEnv

Defined in Mason.Builder.Internal

Methods

byteString :: ByteString -> BuilderFor SocketEnv

flush :: BuilderFor SocketEnv

allocate :: Int -> BuilderFor SocketEnv

cstring :: Ptr Word8 -> Builder

cstringUtf8 :: Ptr Word8 -> Builder

Internal

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

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

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

Allocate a new buffer.

grisu3 :: Double -> Maybe (ByteString, Int)

Decimal encoding of a positive Double.