JSONBytesBuilder.Builder

DSL for construction of JSON.

Literal builders

data Literal

Builder of any JSON literal.

null :: Literal

JSON Null literal.

boolean :: Bool -> Literal

JSON Boolean literal from Bool.

numberFromInt :: Int -> Literal

JSON Number literal from Int.

numberFromInteger :: Integer -> Literal

JSON Number literal from Integer.

numberFromDouble :: Double -> Literal

JSON Number literal from Double.

numberFromScientific :: Scientific -> Literal

JSON Number literal from Scientific.

stringFromText :: Text -> Literal

JSON String literal from Text encoded using UTF8.

stringFromLazyText :: Text -> Literal

JSON String literal from lazy Text encoded using UTF8.

stringFromBytes :: ByteString -> Literal

JSON String literal from ByteString with only escaping applied to it.

stringFromLazyBytes :: ByteString -> Literal

JSON String literal from lazy ByteString with only escaping applied to it.

object :: Rows -> Literal

JSON Object literal from the Rows builder.

objectFromRows :: [Rows] -> Literal

JSON Object literal from a list of rows. A convienience shortcut to object . mconcat for typical cases.

array :: Elements -> Literal

JSON Array literal from the Elements builder.

arrayFromLiterals :: [Literal] -> Literal

JSON Array literal from a list of element literals. A convienience shortcut to array . foldMap element for typical cases.

Rows builders

data Rows

Builder of JSON Object rows.

Instances

Semigroup Rows

Methods

(<>) :: Rows -> Rows -> Rows

sconcat :: NonEmpty Rows -> Rows

stimes :: Integral b => b -> Rows -> Rows

Monoid Rows

Methods

mempty :: Rows

mappend :: Rows -> Rows -> Rows

mconcat :: [Rows] -> Rows

row :: Text -> Literal -> Rows

Rows builder from a key-value pair, where value is an already encoded JSON literal.

Use the Rows Monoid instance to construct multi-row objects.

Elements builders

data Elements

Builder of JSON Array elements.

Instances

Semigroup Elements

Methods

(<>) :: Elements -> Elements -> Elements

sconcat :: NonEmpty Elements -> Elements

stimes :: Integral b => b -> Elements -> Elements

Monoid Elements

Methods

mempty :: Elements

mappend :: Elements -> Elements -> Elements

mconcat :: [Elements] -> Elements

element :: Literal -> Elements

Elements builder from an element, which is an already encoded JSON literal.

Use the Elements Monoid instance to construct multi-element arrays.