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


-- | Fast and simple JSON encoding toolkit
--   
--   Minimalistic library for encoding JSON directly to strict bytestring,
--   which is up to 3x faster than "aeson".
--   
--   For introduction, benchmark results and demo please skip to Readme.
@package jsonifier
@version 0.2


-- | Simple DSL for mapping Haskell values into JSON representation and
--   rendering it into <a>ByteString</a>.
module Jsonifier

-- | Render a JSON value into strict bytestring.
toByteString :: Json -> ByteString

-- | Render a JSON value into Write.
toWrite :: Json -> Write

-- | Specification of how to render a JSON value to <a>ByteString</a>. Sort
--   of a JSON-specialized <a>ByteString</a> builder.
--   
--   You can construct it from Haskell types using the specialized
--   conversion functions like <a>intNumber</a>, <a>textString</a> or
--   <a>object</a>. After constructing, you can convert to strict
--   <a>ByteString</a> using the <a>toByteString</a> function.
data Json

-- | JSON Null literal.
null :: Json

-- | JSON Boolean literal.
bool :: Bool -> Json

-- | JSON Number literal from <tt>Int</tt>.
intNumber :: Int -> Json

-- | JSON Number literal from <tt>Word</tt>.
wordNumber :: Word -> Json

-- | JSON Number literal from <tt>Double</tt>.
--   
--   Since JSON doesn't have support for them, non-real values like
--   <tt>NaN</tt>, <tt>Infinity</tt>, <tt>-Infinity</tt> get rendered as
--   <tt>0</tt>.
doubleNumber :: Double -> Json

-- | JSON Number literal from <tt>Scientific</tt>.
scientificNumber :: Scientific -> Json

-- | JSON String literal from <tt>Text</tt>.
textString :: Text -> Json

-- | JSON String literal from <tt>Scientific</tt>.
--   
--   You may need this when the reader of your JSON cannot handle large
--   number literals.
scientificString :: Scientific -> Json

-- | JSON Array literal from a foldable over element literals.
--   
--   Don't worry about using <a>fmap</a> to map the elements of the input
--   datastructure, it will all be optimized away.
array :: Foldable f => f Json -> Json

-- | JSON Object literal from a foldable over pairs of key to value
--   literal.
--   
--   Don't worry about using <a>fmap</a> to map the elements of the input
--   datastructure, it will all be optimized away.
object :: Foldable f => f (Text, Json) -> Json

-- | Any JSON literal manually rendered as ByteString.
--   
--   This is a low-level function allowing to avoid unnecessary processing
--   in cases where you already have a rendered JSON at hand.
--   
--   <b>Warning:</b>
--   
--   It is your responsibility to ensure that the content is correct JSON.
fromByteString :: ByteString -> Json

-- | Any JSON literal manually rendered as Write.
--   
--   This is a low-level function allowing to avoid unnecessary processing
--   in cases where you already have a rendered JSON at hand.
--   
--   You can think of Write as a specialized version of ByteString builder.
--   You can efficiently convert a ByteString to Write using
--   <a>byteString</a>, making it possible to have parts of the JSON value
--   tree rendered using other libraries. You can as well manually
--   implement encoders for your custom types.
--   
--   <b>Warning:</b>
--   
--   It is your responsibility to ensure that the content is correct,
--   otherwise you may produce invalid JSON.
fromWrite :: Write -> Json