Jordan.ToJSON.Class

Documentation

class Contravariant f => Selectable f where

Basically just Decidable but without a superclass constraint that we cannot implement for JSON.

More specifically, we can quite easily serialize some object into either a string or a number as a top-level JSON value, but we cannot serialize both a string and a number as a top level key. This means that we cannot implement Divisible, but we can implement all the operations from Decidable.

This class lets us decide without being able to divide, which is fun to say.

Methods

giveUp :: (arg -> Void) -> f arg

Give up trying to decide.

select :: (arg -> Either lhs rhs) -> f lhs -> f rhs -> f arg

Pick one thing, or another, as long as you can serialize both options.

Instances

Selectable JSONBuilder

Defined in Jordan.ToJSON.Builder

Methods

giveUp :: (arg -> Void) -> JSONBuilder arg

select :: (arg -> Either lhs rhs) -> JSONBuilder lhs -> JSONBuilder rhs -> JSONBuilder arg

Selectable JSONText

Defined in Jordan.ToJSON.Text

Methods

giveUp :: (arg -> Void) -> JSONText arg

select :: (arg -> Either lhs rhs) -> JSONText lhs -> JSONText rhs -> JSONText arg

class Divisible f => JSONObjectSerializer f where

An abstract representation of how to serialize a JSON object. Since serializing is the exact opposite of parsing, we have to be Decidable instead of Alternative.

That is, if we are serializing a JSON object, we need to be able to break things apart.

Unfortunately the combinators for breaking things apart are more annoying to use than the combinators for putting things together, and involve a lot of tuples everywhere.

Thankfully we provide a good interface to derive these classes generically!

Methods

writeField

Arguments

:: Text

Label for the field to write

-> (forall jsonSerializer. JSONSerializer jsonSerializer => jsonSerializer a)

How to write the field. The forall ensures that JSON serialization is kept completely abstract. You can only use the methods of JSONSerializer here.

-> f a

Instances

JSONObjectSerializer CommaBuilder

Defined in Jordan.ToJSON.Text

Methods

writeField :: Text -> (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> CommaBuilder a

class Divisible f => JSONTupleSerializer f where

Methods

writeItem

Arguments

:: (forall jsonSerializer. JSONSerializer jsonSerializer => jsonSerializer a)

Write a single item into the tuple. The forall keeps things abstract.

-> f a

Instances

JSONTupleSerializer TextArray

Defined in Jordan.ToJSON.Text

Methods

writeItem :: (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> TextArray a

JSONTupleSerializer CommaBuilder

Defined in Jordan.ToJSON.Text

Methods

writeItem :: (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> CommaBuilder a

class Selectable f => JSONSerializer f where

An abstract representation of how to serialize a Haskell value into JSON.

Methods

serializeObject

Arguments

:: Text

A name for the object. Should be "globally unique" as much as possible.

-> (forall objSerializer. JSONObjectSerializer objSerializer => objSerializer a)

How to serialize the object. The forall here keeps things abstract: you are only allowed to use the methods of JSONObjectSerializer here.

-> f a

serializeDictionary :: Foldable t => (forall jsonSerializer. JSONSerializer jsonSerializer => jsonSerializer a) -> f (t (Text, a))

serializeText :: f Text

serializeTextConstant :: Text -> f a

Serialize some text constant. Note that this returns a serializer of anything: if you are always going to serialize out the same string, we don't need to even look at the thing we're serializing!

serializeNull :: f any

serializeNumber :: f Scientific

serializeBool :: f Bool

serializeTuple :: (forall tupleSerializer. JSONTupleSerializer tupleSerializer => tupleSerializer a) -> f a

serializeArray :: ToJSON a => f [a]

Instances

JSONSerializer JSONBuilder

Defined in Jordan.ToJSON.Builder

Methods

serializeObject :: Text -> (forall (objSerializer :: Type -> Type). JSONObjectSerializer objSerializer => objSerializer a) -> JSONBuilder a

serializeDictionary :: Foldable t => (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> JSONBuilder (t (Text, a))

serializeText :: JSONBuilder Text

serializeTextConstant :: Text -> JSONBuilder a

serializeNull :: JSONBuilder any

serializeNumber :: JSONBuilder Scientific

serializeBool :: JSONBuilder Bool

serializeTuple :: (forall (tupleSerializer :: Type -> Type). JSONTupleSerializer tupleSerializer => tupleSerializer a) -> JSONBuilder a

serializeArray :: ToJSON a => JSONBuilder [a]

JSONSerializer JSONText

Defined in Jordan.ToJSON.Text

Methods

serializeObject :: Text -> (forall (objSerializer :: Type -> Type). JSONObjectSerializer objSerializer => objSerializer a) -> JSONText a

serializeDictionary :: Foldable t => (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> JSONText (t (Text, a))

serializeText :: JSONText Text

serializeTextConstant :: Text -> JSONText a

serializeNull :: JSONText any

serializeNumber :: JSONText Scientific

serializeBool :: JSONText Bool

serializeTuple :: (forall (tupleSerializer :: Type -> Type). JSONTupleSerializer tupleSerializer => tupleSerializer a) -> JSONText a

serializeArray :: ToJSON a => JSONText [a]

class ToJSON v where

A class to provide the canonical way to encode a JSON.

This class uses finally tagless style to keep the instructions for serializing abstract. This allows us to automatically generate documentation, and to generate serializers that always avoid the need for intermediate structures.

This class is derivable generically, and will generate a "nice" format. In my opinion, at least.

Minimal complete definition

Nothing

Methods

toJSON :: JSONSerializer f => f v

default toJSON :: (Generic v, GToJSON (Rep v)) => JSONSerializer f => f v

Instances

ToJSON Bool

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Bool

ToJSON Double

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Double

ToJSON Float

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Float

ToJSON Int

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Int

ToJSON Integer

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Integer

ToJSON ()

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f ()

ToJSON Text

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Text

ToJSON String

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f String

ToJSON All

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f All

ToJSON Any

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Any

ToJSON Scientific

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f Scientific

ToJSON a => ToJSON [a]

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f [a]

ToJSON a => ToJSON (Maybe a)

Nothings get serialized as null.

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Maybe a)

(ToJSON a, Typeable a) => ToJSON (Ratio a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Ratio a)

ToJSON a => ToJSON (Min a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Min a)

ToJSON a => ToJSON (Max a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Max a)

ToJSON a => ToJSON (First a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (First a)

ToJSON a => ToJSON (Last a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Last a)

ToJSON a => ToJSON (Dual a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Dual a)

ToJSON a => ToJSON (Sum a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Sum a)

ToJSON a => ToJSON (Product a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Product a)

(ToJSON lhs, ToJSON rhs) => ToJSON (Either lhs rhs)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Either lhs rhs)

ToJSON a => ToJSON (Map Text a)

Defined in Jordan.ToJSON.Class

Methods

toJSON :: JSONSerializer f => f (Map Text a)

data ToJSONOptions

Constructors

ToJSONOptions

Fields

• toJSONEncodeSums :: SumTypeEncoding
• toJSONBaseName :: String
• toJSONRenderEnum :: String -> String

defaultToJSONOptions :: ToJSONOptions

class GToJSON v where

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (v a)

Instances

GToJSON (V1 :: Type -> Type)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (V1 a)

(GToJSON (PartOfSum l), GToJSON (PartOfSum r)) => GToJSON (PartOfSum (l :+: r))

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (PartOfSum (l :+: r) a)

(Constructor t, GToJSON (C1 t f)) => GToJSON (PartOfSum (C1 t f))

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (PartOfSum (C1 t f) a)

Constructor t => GToJSON (PartOfSum (C1 t (U1 :: Type -> Type)))

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (PartOfSum (C1 t U1) a)

ToJSON c => GToJSON (K1 i c :: Type -> Type)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (K1 i c a)

(GToJSON (PartOfSum l), GToJSON (PartOfSum r)) => GToJSON (l :+: r)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s ((l :+: r) a)

(GToJSON f, Datatype t) => GToJSON (D1 t f)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (D1 t f a)

ToJSON i => GToJSON (C1 c (S1 ('MetaSel ('Nothing :: Maybe Symbol) su ss ds) (Rec0 i)))

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (C1 c (S1 ('MetaSel 'Nothing su ss ds) (Rec0 i)) a)

(GToJSONObject inner, Constructor t) => GToJSON (C1 t inner)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s => ToJSONOptions -> s (C1 t inner a)

GToJSON s => GToJSON (S1 whatever s)

Defined in Jordan.ToJSON.Class

Methods

gToJSON :: JSONSerializer s0 => ToJSONOptions -> s0 (S1 whatever s a)

sumToEither :: (l :+: r) a -> Either (l a) (r a)

class GToJSONObject v where

Methods

gToJSONObject :: JSONObjectSerializer f => ToJSONOptions -> f (v a)

Instances

(GToJSONObject lhs, GToJSONObject rhs) => GToJSONObject (lhs :*: rhs)

Defined in Jordan.ToJSON.Class

Methods

gToJSONObject :: JSONObjectSerializer f => ToJSONOptions -> f ((lhs :*: rhs) a)

(GToJSON f, Selector t) => GToJSONObject (S1 t f)

Defined in Jordan.ToJSON.Class

Methods

gToJSONObject :: JSONObjectSerializer f0 => ToJSONOptions -> f0 (S1 t f a)