Maintainer	Leon P Smith <leon@melding-monads.com>

Data.Json.Builder

Description

Data structure agnostic JSON serialization

Synopsis

Documentation

class Value a => Key a whereSource

The Key typeclass represents types that are rendered into json strings. They are special because only strings can appear as field names of a json objects.

Methods

escape :: a -> Escaped Source

Instances

Key Text
Key Text
Key ByteString
Key ByteString
Key Escaped
Key [Char]

class Value a whereSource

The Value typeclass represents types that can be rendered into valid json syntax.

Methods

toBuilder :: a -> Builder Source

Instances

Value Bool
Value Double
Value Float
Value Int
Value Int8
Value Int16
Value Int32
Value Int64
Value Integer
Value Word
Value Word8
Value Word16
Value Word32
Value Word64
Value ()
Value Text
Value Text
Value ByteString
Value ByteString
Value Array
Value Object
Value Escaped
Value [Char]
Value a => Value [a]
(Key k, Value a) => Value (Map k a)
(Key k, Value a) => Value (HashMap k a)

data Object Source

The Object type represents a builder that constructs syntax for a json object. It has a singleton constructor row, and an instance of monoid, so that arbitrary objects can be constructed. Note that duplicate field names will appear in the output, so it is up to the user of this interface to avoid duplicate field names.

Instances

Monoid Object
Value Object

row :: (Key k, Value a) => k -> a -> Object Source

The row constructs a json object consisting of exactly one field. These objects can be concatinated using mappend.

data Array Source

The Array type represents a builder that constructs syntax for a json array. It has a singleton constructor element and an instance of monoid, so that arbitrary arrays can be constructed.

Instances

Monoid Array
Value Array

element :: Value a => a -> Array Source

The element function constructs a json array consisting of exactly one value. These arrays can be concatinated using mappend.

newtype Escaped Source

The Escaped type is a special Builder value that represents a UTF-8 encoded string with all necessary characters json-escaped. These builders must not render the opening or closing quotes, which are instead rendered by toBuilder. This is so that Json strings can be efficiently constructed from multiple Haskell strings without actually concatinating the Haskell strings (which might require some kind of conversion in addition to concatination.)

Constructors

Escaped Builder

Instances

Monoid Escaped
Value Escaped
Key Escaped