-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Fast and extensible bytestring builder
--   
--   See README.md
@package mason
@version 0

module Mason.Builder.Internal

-- | The Builder type. Requires RankNTypes extension
type Builder = forall s. Buildable s => BuilderFor s

-- | Builder specialised for a backend
newtype BuilderFor s
Builder :: (s -> Buffer -> IO Buffer) -> BuilderFor s
[unBuilder] :: BuilderFor s -> s -> Buffer -> IO Buffer

-- | This class is used to provide backend-specific operations for running
--   a <a>Builder</a>.
class Buildable s

-- | Put a <a>ByteString</a>.
byteString :: Buildable s => ByteString -> BuilderFor s

-- | Flush the content of the internal buffer.
flush :: Buildable s => BuilderFor s

-- | Allocate a buffer with at least the given length.
allocate :: Buildable s => Int -> BuilderFor s
newtype GrowingBuffer
GrowingBuffer :: IORef (ForeignPtr Word8) -> GrowingBuffer

-- | Buffer pointers
data Buffer
Buffer :: {-# UNPACK #-} !Ptr Word8 -> {-# UNPACK #-} !Ptr Word8 -> Buffer

-- | end of the buffer (next to the last byte)
[bEnd] :: Buffer -> {-# UNPACK #-} !Ptr Word8

-- | current position
[bCur] :: Buffer -> {-# UNPACK #-} !Ptr Word8

-- | Copy a <a>ByteString</a> to a buffer.
byteStringCopy :: Buildable s => ByteString -> BuilderFor s

-- | Copy a <a>ShortByteString</a> to a buffer.
shortByteString :: ShortByteString -> Builder

-- | Create a strict <a>ByteString</a>
toStrictByteString :: BuilderFor GrowingBuffer -> ByteString
data Channel
Channel :: !MVar ByteString -> !IORef (ForeignPtr Word8) -> Channel
[chResp] :: Channel -> !MVar ByteString
[chBuffer] :: Channel -> !IORef (ForeignPtr Word8)

-- | Create a lazy <a>ByteString</a>. Threaded runtime is required.
toLazyByteString :: BuilderFor Channel -> ByteString

-- | UTF-8 encode a <a>String</a>.
stringUtf8 :: String -> Builder

-- | Run a builder within a buffer and prefix it by the length.
lengthPrefixedWithin :: Int -> BoundedPrim Int -> BuilderFor () -> Builder

-- | Use <a>BoundedPrim</a>
primBounded :: BoundedPrim a -> a -> Builder

-- | Use <a>FixedPrim</a>
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

-- | Write a <a>Builder</a> into a handle and obtain the number of bytes
--   written. <a>flush</a> does not imply actual disk operations. Set
--   <a>NoBuffering</a> if you want it to write the content immediately.
hPutBuilderLen :: Handle -> BuilderFor PutBuilderEnv -> IO Int

-- | Environemnt for handle output
data PutBuilderEnv
PBE :: !Handle -> !IORef (ForeignPtr Word8) -> !IORef Int -> PutBuilderEnv
[pbHandle] :: PutBuilderEnv -> !Handle
[pbBuffer] :: PutBuilderEnv -> !IORef (ForeignPtr Word8)
[pbTotal] :: PutBuilderEnv -> !IORef Int

-- | Encode <a>Text</a> with a custom escaping function
encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder

-- | Write a <a>Builder</a> into a handle and obtain the number of bytes
--   written.
sendBuilder :: Socket -> BuilderFor SocketEnv -> IO Int

-- | Environemnt for socket output
data SocketEnv
SE :: !Socket -> !IORef (ForeignPtr Word8) -> !IORef Int -> SocketEnv
[seSocket] :: SocketEnv -> !Socket
[seBuffer] :: SocketEnv -> !IORef (ForeignPtr Word8)
[seCounter] :: SocketEnv -> !IORef Int
cstring :: Ptr Word8 -> Builder
cstringUtf8 :: Ptr Word8 -> Builder

-- | Ensure that the given number of bytes is available in the buffer.
--   Subject to semigroup fusions
ensure :: Int -> (Buffer -> IO Buffer) -> Builder

-- | Allocate a new buffer.
allocateConstant :: (s -> IORef (ForeignPtr Word8)) -> Int -> BuilderFor s

-- | Decimal encoding of a positive <a>Double</a>.
grisu3 :: Double -> Maybe (ByteString, Int)
instance Mason.Builder.Internal.Buildable Mason.Builder.Internal.SocketEnv
instance Mason.Builder.Internal.Buildable Mason.Builder.Internal.PutBuilderEnv
instance Mason.Builder.Internal.Buildable Mason.Builder.Internal.Channel
instance Mason.Builder.Internal.Buildable Mason.Builder.Internal.GrowingBuffer
instance Mason.Builder.Internal.Buildable ()
instance Mason.Builder.Internal.Buildable s => Data.String.IsString (Mason.Builder.Internal.BuilderFor s)
instance GHC.Base.Semigroup (Mason.Builder.Internal.BuilderFor s)
instance GHC.Base.Monoid (Mason.Builder.Internal.BuilderFor a)


module Mason.Builder

-- | The Builder type. Requires RankNTypes extension
type Builder = forall s. Buildable s => BuilderFor s

-- | Builder specialised for a backend
data BuilderFor s

-- | This class is used to provide backend-specific operations for running
--   a <a>Builder</a>.
class Buildable s

-- | Create a strict <a>ByteString</a>
toStrictByteString :: BuilderFor GrowingBuffer -> ByteString

-- | Create a lazy <a>ByteString</a>. Threaded runtime is required.
toLazyByteString :: BuilderFor Channel -> ByteString

-- | Write a <a>Builder</a> into a handle and obtain the number of bytes
--   written. <a>flush</a> does not imply actual disk operations. Set
--   <a>NoBuffering</a> if you want it to write the content immediately.
hPutBuilderLen :: Handle -> BuilderFor PutBuilderEnv -> IO Int

-- | Put the content of a <a>Builder</a> to a <a>Handle</a>.
hPutBuilder :: Handle -> BuilderFor PutBuilderEnv -> IO ()

-- | Write a <a>Builder</a> into a handle and obtain the number of bytes
--   written.
sendBuilder :: Socket -> BuilderFor SocketEnv -> IO Int

-- | Flush the content of the internal buffer.
flush :: Buildable s => BuilderFor s

-- | Encode <a>Text</a> as a UTF-8 byte stream.
encodeUtf8Builder :: Text -> Builder

-- | Encode <a>Text</a> with a custom escaping function
encodeUtf8BuilderEscaped :: BoundedPrim Word8 -> Text -> Builder

-- | Put a <a>ByteString</a>.
byteString :: Buildable s => ByteString -> BuilderFor s

-- | Combine chunks of a lazy <a>ByteString</a>
lazyByteString :: ByteString -> Builder

-- | Copy a <a>ShortByteString</a> to a buffer.
shortByteString :: ShortByteString -> Builder

-- | Encode a single signed byte as-is.
int8 :: Int8 -> Builder

-- | Encode a single unsigned byte as-is.
word8 :: Word8 -> Builder

-- | Encode an <a>Int16</a> in little endian format.
int16LE :: Int16 -> Builder

-- | Encode an <a>Int32</a> in little endian format.
int32LE :: Int32 -> Builder

-- | Encode an <a>Int64</a> in little endian format.
int64LE :: Int64 -> Builder

-- | Encode a <a>Word16</a> in little endian format.
word16LE :: Word16 -> Builder

-- | Encode a <a>Word32</a> in little endian format.
word32LE :: Word32 -> Builder

-- | Encode a <a>Word64</a> in little endian format.
word64LE :: Word64 -> Builder

-- | Encode a <a>Float</a> in little endian format.
floatLE :: Float -> Builder

-- | Encode a <a>Double</a> in little endian format.
doubleLE :: Double -> Builder

-- | Encode an <a>Int16</a> in big endian format.
int16BE :: Int16 -> Builder

-- | Encode an <a>Int32</a> in big endian format.
int32BE :: Int32 -> Builder

-- | Encode an <a>Int64</a> in big endian format.
int64BE :: Int64 -> Builder

-- | Encode a <a>Word16</a> in big endian format.
word16BE :: Word16 -> Builder

-- | Encode a <a>Word32</a> in big endian format.
word32BE :: Word32 -> Builder

-- | Encode a <a>Word64</a> in big endian format.
word64BE :: Word64 -> Builder

-- | Encode a <a>Float</a> in big endian format.
floatBE :: Float -> Builder

-- | Encode a <a>Double</a> in big endian format.
doubleBE :: Double -> Builder

-- | Char7 encode a <a>Char</a>.
char7 :: Char -> Builder

-- | Char7 encode a <a>String</a>.
string7 :: String -> Builder

-- | Char8 encode a <a>Char</a>.
char8 :: Char -> Builder

-- | Char8 encode a <a>String</a>.
string8 :: String -> Builder

-- | UTF-8 encode a <a>Char</a>.
charUtf8 :: Char -> Builder

-- | UTF-8 encode a <a>String</a>.
stringUtf8 :: String -> Builder

-- | <i>Currently slow.</i> Decimal encoding of an IEEE <a>Float</a>.
floatDec :: Float -> Builder

-- | Decimal encoding of an IEEE <a>Double</a>.
doubleDec :: Double -> Builder

-- | Decimal encoding of a <a>Word8</a> using the ASCII digits.
word8Dec :: Word8 -> Builder

-- | Decimal encoding of a <a>Word16</a> using the ASCII digits.
word16Dec :: Word16 -> Builder

-- | Decimal encoding of a <a>Word32</a> using the ASCII digits.
word32Dec :: Word32 -> Builder

-- | Decimal encoding of a <a>Word64</a> using the ASCII digits.
word64Dec :: Word64 -> Builder

-- | Decimal encoding of a <a>Word</a> using the ASCII digits.
wordDec :: Word -> Builder

-- | Decimal encoding of an <a>Int8</a> using the ASCII digits.
--   
--   e.g.
--   
--   <pre>
--   toLazyByteString (int8Dec 42)   = "42"
--   toLazyByteString (int8Dec (-1)) = "-1"
--   </pre>
int8Dec :: Int8 -> Builder

-- | Decimal encoding of an <a>Int16</a> using the ASCII digits.
int16Dec :: Int16 -> Builder

-- | Decimal encoding of an <a>Int32</a> using the ASCII digits.
int32Dec :: Int32 -> Builder

-- | Decimal encoding of an <a>Int64</a> using the ASCII digits.
int64Dec :: Int64 -> Builder

-- | Decimal encoding of an <a>Int</a> using the ASCII digits.
intDec :: Int -> Builder

-- | Decimal encoding of an <a>Integer</a> using the ASCII digits. Simon
--   Meier's improved implementation from
--   <a>https://github.com/haskell/bytestring/commit/92f19a5d94761042b44a433d7331107611e4d717</a>
integerDec :: Integer -> Builder

-- | Shortest hexadecimal encoding of a <a>Word8</a> using lower-case
--   characters.
word8Hex :: Word8 -> Builder

-- | Shortest hexadecimal encoding of a <a>Word16</a> using lower-case
--   characters.
word16Hex :: Word16 -> Builder

-- | Shortest hexadecimal encoding of a <a>Word32</a> using lower-case
--   characters.
word32Hex :: Word32 -> Builder

-- | Shortest hexadecimal encoding of a <a>Word64</a> using lower-case
--   characters.
word64Hex :: Word64 -> Builder

-- | Shortest hexadecimal encoding of a <a>Word</a> using lower-case
--   characters.
wordHex :: Word -> Builder

-- | Encode a <a>Int8</a> using 2 nibbles (hexadecimal digits).
int8HexFixed :: Int8 -> Builder

-- | Encode a <a>Int16</a> using 4 nibbles.
int16HexFixed :: Int16 -> Builder

-- | Encode a <a>Int32</a> using 8 nibbles.
int32HexFixed :: Int32 -> Builder

-- | Encode a <a>Int64</a> using 16 nibbles.
int64HexFixed :: Int64 -> Builder

-- | Encode a <a>Word8</a> using 2 nibbles (hexadecimal digits).
word8HexFixed :: Word8 -> Builder

-- | Encode a <a>Word16</a> using 4 nibbles.
word16HexFixed :: Word16 -> Builder

-- | Encode a <a>Word32</a> using 8 nibbles.
word32HexFixed :: Word32 -> Builder

-- | Encode a <a>Word64</a> using 16 nibbles.
word64HexFixed :: Word64 -> Builder

-- | Encode an IEEE <a>Float</a> using 8 nibbles.
floatHexFixed :: Float -> Builder

-- | Encode an IEEE <a>Double</a> using 16 nibbles.
doubleHexFixed :: Double -> Builder

-- | Encode each byte of a <a>ByteString</a> using its fixed-width hex
--   encoding.
byteStringHex :: ByteString -> Builder

-- | Encode each byte of a lazy <a>ByteString</a> using its fixed-width hex
--   encoding.
lazyByteStringHex :: ByteString -> Builder

-- | Use <a>FixedPrim</a>
primFixed :: FixedPrim a -> a -> Builder

-- | Use <a>BoundedPrim</a>
primBounded :: BoundedPrim a -> a -> Builder

-- | Run a builder within a buffer and prefix it by the length.
lengthPrefixedWithin :: Int -> BoundedPrim Int -> BuilderFor () -> Builder