Text.RJson

Documentation

class TranslateField a where

Methods

translateField :: a -> String -> String

By default, Haskell record field names are converted into JSON object field names by stripping any initial underscores. Specialize this method to define a different behavior.

Instances

Typeable a => TranslateField a

Removes initial underscores from a string.

data TranslateFieldD a

Instances

TranslateField t => Sat (TranslateFieldD t)

class TranslateField a => ToJson a where

New instances can be added to this class to customize JSON serialization.

Methods

toJson :: a -> JsonData

exclude :: a -> String -> Bool

You can specialize this method to prevent fields from being serialized. The method should return a list of the Haskell names of the fields to be excluded.

arrayPrepend :: a -> [JsonData]

Types that will be converted to JSON arrays can override this method to specify additional elements to be prepended to the array.

arrayAppend :: a -> [JsonData]

Types that will be converted to JSON arrays can override this method to specify additional elements to be appended to the array.

objectExtras :: a -> [(String, JsonData)]

Types that will be converted to JSON objects can override this method to specify additional fields of the object.

Instances

ToJson Bool

ToJson Char

ToJson Double

ToJson Int

ToJson Integer

(Data ToJsonD t, TranslateField t) => ToJson t

(ToJson a, TranslateField a, Typeable a) => ToJson [a]

(Integral a, TranslateField a, Typeable a) => ToJson (Ratio a)

(ToJson a, Typeable a, ToJson b, Typeable b) => ToJson (a, b)

(ToJson a, TranslateField a, Typeable a, Typeable i, Ix i) => ToJson (Array i a)

(ToJson a, TranslateField a, Data TranslateFieldD (Map String a)) => ToJson (Map String a)

(ToJson a, ToJson b, TranslateField a, TranslateField b, Typeable a, Typeable b, Typeable2 Union) => ToJson (Union a b)

(ToJson a, Typeable a, ToJson b, Typeable b, ToJson c, Typeable c) => ToJson (a, b, c)

(ToJson a, Typeable a, ToJson b, Typeable b, ToJson c, Typeable c, ToJson d, Typeable d) => ToJson (a, b, c, d)

(ToJson a, Typeable a, ToJson b, Typeable b, ToJson c, Typeable c, ToJson d, Typeable d, ToJson e, Typeable e) => ToJson (a, b, c, d, e)

(ToJson a, Typeable a, ToJson b, Typeable b, ToJson c, Typeable c, ToJson d, Typeable d, ToJson e, Typeable e, ToJson f, Typeable f) => ToJson (a, b, c, d, e, f)

(ToJson a, Typeable a, ToJson b, Typeable b, ToJson c, Typeable c, ToJson d, Typeable d, ToJson e, Typeable e, ToJson f, Typeable f, ToJson g, Typeable g) => ToJson (a, b, c, d, e, f, g)

data ToJsonD a

Instances

ToJson t => Sat (ToJsonD t)

genericToJson :: (Data ToJsonD a, ToJson a, TranslateField a) => a -> JsonData

This is the implementation of toJson for the generic instance declaration, but it's useful to be able to use the same implentation for other instance declarations which override the default implementation of exclude.

enumToJson :: (Data ToJsonD a, ToJson a, TranslateField a) => (String -> String) -> a -> JsonData

This function can be used as an implementation of toJson for simple enums. It just converts an enum value to a string determined by the name of the constructor, after being fed through the (String -> String) function given as the first argument.

data JsonData

A Haskell representation of a JSON data structure.

Constructors

JDString String

JDNumber Double

JDArray [JsonData]

JDBool Bool

JDObject (Map String JsonData)

Instances

Show JsonData

class TranslateField a => FromJson a where

Methods

fromJson :: a -> JsonData -> Either String a

objectDefaults :: a -> Map String JsonData

In order to specify default values for required fields of a JSON object, specialize this method in the instance definition for the relevant datatype.

Instances

FromJson Bool

FromJson Char

FromJson Double

FromJson Int

FromJson Integer

(Data FromJsonD t, TranslateField t) => FromJson t

(FromJson a, TranslateField a, Typeable a) => FromJson [a]

(Typeable a, Integral a) => FromJson (Ratio a)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b) => FromJson (a, b)

(FromJson a, FromJson b, Typeable a, Typeable b, TranslateField a, TranslateField b) => FromJson (Union a b)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b, FromJson c, Typeable c, TranslateField c) => FromJson (a, b, c)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b, FromJson c, Typeable c, TranslateField c, FromJson d, Typeable d, TranslateField d) => FromJson (a, b, c, d)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b, FromJson c, Typeable c, TranslateField c, FromJson d, Typeable d, TranslateField d, FromJson e, Typeable e, TranslateField e) => FromJson (a, b, c, d, e)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b, FromJson c, Typeable c, TranslateField c, FromJson d, Typeable d, TranslateField d, FromJson e, Typeable e, TranslateField e, FromJson f, Typeable f, TranslateField f) => FromJson (a, b, c, d, e, f)

(FromJson a, Typeable a, TranslateField a, FromJson b, Typeable b, TranslateField b, FromJson c, Typeable c, TranslateField c, FromJson d, Typeable d, TranslateField d, FromJson e, Typeable e, TranslateField e, FromJson f, Typeable f, TranslateField f, FromJson g, Typeable g, TranslateField g) => FromJson (a, b, c, d, e, f, g)

data FromJsonD a

Instances

FromJson t => Sat (FromJsonD t)

parseJsonString :: String -> Either String JsonData

Converts a String (interpreted as a true unicode String) to an instance of JsonData.

parseJsonByteString :: ByteString -> Either String JsonData

Converts a ByteString to an instance of JsonData (unicode encoding is detected automatically).

fromJsonString :: FromJson a => a -> String -> Either String a

Converts a JSON String (interpreted as a true unicode string) to a value of the type given by the first (dummy) argument.

fromJsonByteString :: FromJson a => a -> ByteString -> Either String a

Converts a JSON ByteString (with unicode encoding automatically detected) to a value of the type given by the first (dummy) argument.

genericFromJson :: (Data FromJsonD a, FromJson a, TranslateField a) => a -> JsonData -> Either String a

enumFromJson :: (Data FromJsonD a, Data TranslateFieldD a) => (String -> String) -> a -> JsonData -> Either String a

The counterpart of enumToJson.

stripInitialUnderscores :: [Char] -> [Char]

toJsonString :: ToJson a => a -> String

Converts a value to an ASCII-only JSON String.

firstCharToUpper :: String -> String

firstCharToLower :: String -> String

data Union a b

Use this for merging two or more records together. Sensible instances of FromJson and ToJson are already defined for this type.

Constructors

Union a b

Instances

Typeable2 Union

(Data ctx a[a28s], Data ctx b[a28t], Sat (ctx (Union a[a28s] b[a28t]))) => Data ctx (Union a[a28s] b[a28t])

(Show a, Show b) => Show (Union a b)

(ToJson a, ToJson b, TranslateField a, TranslateField b, Typeable a, Typeable b, Typeable2 Union) => ToJson (Union a b)

(FromJson a, FromJson b, Typeable a, Typeable b, TranslateField a, TranslateField b) => FromJson (Union a b)

type Union3 a b c = Union (Union a b) c

Nested Unions are left-branching by convention (since this is what you get by using the constructor as an infix operator).

type Union4 a b c d = Union (Union3 a b c) d

type Union5 a b c d e = Union (Union4 a b c d) e

type Union6 a b c d e f = Union (Union5 a b c d e) f

type Union7 a b c d e f g = Union (Union6 a b c d e f) g

type Union8 a b c d e f g h = Union (Union7 a b c d e f g) h

type Union9 a b c d e f g h i = Union (Union8 a b c d e f g h) i

type Union10 a b c d e f g h i j = Union (Union9 a b c d e f g h i) j