Safe Haskell	None
Language	Haskell2010

Mason.Builder.Internal

Contents

Internal

Synopsis

type Builder = forall s. Buildable s => BuilderFor s
newtype BuilderFor s = Builder {
- unBuilder :: s -> Buffer -> IO Buffer
}
class Buildable s where
- byteString :: ByteString -> BuilderFor s
- flush :: BuilderFor s
- allocate :: Int -> BuilderFor s
newtype GrowingBuffer = GrowingBuffer (IORef (ForeignPtr Word8))
data Buffer = Buffer {
- bEnd :: !(Ptr Word8)
- bCur :: !(Ptr Word8)
}
byteStringCopy :: Buildable s => ByteString -> BuilderFor s
shortByteString :: ShortByteString -> Builder
toStrictByteString :: BuilderFor GrowingBuffer -> ByteString
data Channel = Channel {
- chResp :: !(MVar ByteString)
- chBuffer :: !(IORef (ForeignPtr Word8))
}
toLazyByteString :: BuilderFor Channel -> ByteString
stringUtf8 :: String -> Builder
lengthPrefixedWithin :: Int -> BoundedPrim Int -> BuilderFor () -> Builder
primBounded :: BoundedPrim a -> a -> Builder
primFixed :: FixedPrim a -> a -> Builder
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
data PutBuilderEnv = PBE {
- pbHandle :: !Handle
- pbBuffer :: !(IORef (ForeignPtr Word8))
- pbTotal :: !(IORef Int)
}
encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder
sendBuilder :: Socket -> BuilderFor SocketEnv -> IO Int
data SocketEnv = SE {
- seSocket :: !Socket
- seBuffer :: !(IORef (ForeignPtr Word8))
- seCounter :: !(IORef Int)
}
cstring :: Ptr Word8 -> Builder
cstringUtf8 :: Ptr Word8 -> Builder
ensure :: Int -> (Buffer -> IO Buffer) -> Builder
allocateConstant :: (s -> IORef (ForeignPtr Word8)) -> Int -> BuilderFor s
grisu3 :: Double -> Maybe (ByteString, Int)

Documentation

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

The Builder type. Requires RankNTypes extension

newtype BuilderFor s Source #

Builder specialised for a backend

Constructors

Builder
Fields unBuilder :: s -> Buffer -> IO Buffer

Instances

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

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

Methods

byteString :: ByteString -> BuilderFor s Source #

Put a ByteString.

flush :: BuilderFor s Source #

Flush the content of the internal buffer.

allocate :: Int -> BuilderFor s Source #

Allocate a buffer with at least the given length.

Instances

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 SocketEnv Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor SocketEnv Source # flush :: BuilderFor SocketEnv Source # allocate :: Int -> BuilderFor SocketEnv Source #
Buildable PutBuilderEnv Source #
Instance details Defined in Mason.Builder.Internal Methods byteString :: ByteString -> BuilderFor PutBuilderEnv Source # flush :: BuilderFor PutBuilderEnv Source # allocate :: Int -> BuilderFor PutBuilderEnv 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 #

newtype GrowingBuffer Source #

Constructors

GrowingBuffer (IORef (ForeignPtr Word8))

Instances

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 #

data Buffer Source #

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

Copy a ByteString to a buffer.

shortByteString :: ShortByteString -> Builder Source #

Copy a ShortByteString to a buffer.

toStrictByteString :: BuilderFor GrowingBuffer -> ByteString Source #

Create a strict ByteString

data Channel Source #

Constructors

Channel
Fields chResp :: !(MVar ByteString) chBuffer :: !(IORef (ForeignPtr Word8))

Instances

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 #

toLazyByteString :: BuilderFor Channel -> ByteString Source #

Create a lazy ByteString. Threaded runtime is required.

stringUtf8 :: String -> Builder Source #

UTF-8 encode a String.

lengthPrefixedWithin Source #

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

Use BoundedPrim

primFixed :: FixedPrim a -> a -> Builder Source #

Use FixedPrim

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

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

primMapByteStringFixed :: FixedPrim Word8 -> ByteString -> Builder Source #

primMapLazyByteStringFixed :: FixedPrim Word8 -> ByteString -> Builder Source #

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

data PutBuilderEnv Source #

Environemnt for handle output

Constructors

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

Instances

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

encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder Source #

Encode Text with a custom escaping function

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

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

data SocketEnv Source #

Environemnt for socket output

Constructors

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

Instances

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

cstring :: Ptr Word8 -> Builder Source #

cstringUtf8 :: Ptr Word8 -> Builder Source #

Internal

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

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

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

Allocate a new buffer.

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

Decimal encoding of a positive Double.