Jordan.FromJSON.Class

Parse JSON using finally-tagless style.

This provides JSON parsing as an abstract interface. This interface provides a way to parse JSON that is *inspectable* and has some nice properties: for example, we can use it to build a parser that directly parses your data structure, without building some intermediate value type!

Documentation

class Applicative f => JSONObjectParser f where

A class for parsing JSON objects.

Minimal complete definition

parseFieldWith

Methods

parseFieldWith

Arguments

:: Text

Label of the field. Will be parsed into escaped text, if need be.

-> (forall valueParser. JSONParser valueParser => valueParser a)

How to parse the field. Note the forall in this type signature: you cannot have this be specific to any particular implementation of parsing, to keep the parsing of a JSON abstract.

-> f a

Parse an object field with a given label, using a parser.

Note: in order to enable the generation of better documentation, use parseField instead if at all possible!

parseField :: FromJSON v => Text -> f v

Instances

JSONObjectParser ObjectParser

Defined in Jordan.FromJSON.Megaparsec

Methods

parseFieldWith :: Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> ObjectParser a

parseField :: FromJSON v => Text -> ObjectParser v

class Applicative f => JSONTupleParser f where

A class for parsing JSON arrays.

Minimal complete definition

consumeItemWith

Methods

consumeItemWith :: (forall valueParser. JSONParser valueParser => valueParser a) -> f a

Use a JSON parser to consume a single item of an array, then move onto the next one.

Note: you should prefer consumeItem as it enables better documentation generation.

consumeItem :: FromJSON v => f v

Consume a single array item.

Instances

JSONTupleParser ArrayParser

Defined in Jordan.FromJSON.Megaparsec

Methods

consumeItemWith :: (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> ArrayParser a

consumeItem :: FromJSON v => ArrayParser v

class (Functor f, forall a. Monoid (f a)) => JSONParser f where

Abstract class representing various parsers.

All parsers must have a Monoid instance that represents choice with failure as the identity.

Minimal complete definition

parseObject, parseDictionary, parseText, parseTuple, parseArrayWith, parseNumber, parseNull, parseBool, validateJSON

Methods

parseObject

Arguments

:: Text

A label for the object. This label should, as much as possible, be "globally unique" in some way. This will enable better generation of documentation.

-> (forall objectParser. JSONObjectParser objectParser => objectParser a)

Instructions on how to parse the object. Note that the actual implementation is kept abstract: you can only use methods found in JSONObjectParser, or combinators of those methods. This ensures that we can generate the proper parser in all cases.

-> f a

parseObjectStrict :: Text -> (forall objectParser. JSONObjectParser objectParser => objectParser a) -> f a

Parse an object where you are okay if we parse strictly, IE, do not allow extra fields. This sometimes enables us to generate parsers that run faster.

parseDictionary :: (forall jsonParser. JSONParser jsonParser => jsonParser a) -> f [(Text, a)]

Parse a dictionary of key-value pairs.

parseText :: f Text

Parse a text field.

parseTextConstant :: Text -> f ()

parseTuple :: (forall arrayParser. JSONTupleParser arrayParser => arrayParser o) -> f o

Use a tuple parser to parse an array.

parseArray :: FromJSON a => f [a]

parseArrayWith :: (forall jsonParser. JSONParser jsonParser => jsonParser a) -> f [a]

parseNumber :: f Scientific

parseNull :: f ()

parseBool :: f Bool

validateJSON :: f (Either Text a) -> f a

Instances

JSONParser MegaparsecParser

Defined in Jordan.FromJSON.Megaparsec

Methods

parseObject :: Text -> (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> MegaparsecParser a

parseObjectStrict :: Text -> (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> MegaparsecParser a

parseDictionary :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> MegaparsecParser [(Text, a)]

parseText :: MegaparsecParser Text

parseTextConstant :: Text -> MegaparsecParser ()

parseTuple :: (forall (arrayParser :: Type -> Type). JSONTupleParser arrayParser => arrayParser o) -> MegaparsecParser o

parseArray :: FromJSON a => MegaparsecParser [a]

parseArrayWith :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> MegaparsecParser [a]

parseNumber :: MegaparsecParser Scientific

parseNull :: MegaparsecParser ()

parseBool :: MegaparsecParser Bool

validateJSON :: MegaparsecParser (Either Text a) -> MegaparsecParser a

class FromJSON value where

A class to provide the canonical way to parse a JSON. This class uses finally tagless tyle to keep the instructions for parsing abstract. This allows us to automatically generate documentation, and to generate parsers that do not use intermediate structures.

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

Minimal complete definition

Nothing

Methods

fromJSON :: JSONParser f => f value

default fromJSON :: (Generic value, GFromJSON (Rep value)) => JSONParser f => f value

Instances

FromJSON Bool

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Bool

FromJSON Double

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Double

FromJSON Float

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Float

FromJSON Int

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Int

FromJSON Integer

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Integer

FromJSON ()

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f ()

FromJSON Text

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Text

FromJSON String

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f String

FromJSON All

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f All

FromJSON Any

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Any

FromJSON Scientific

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f Scientific

FromJSON a => FromJSON [a]

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f [a]

FromJSON a => FromJSON (Maybe a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Maybe a)

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

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Ratio a)

FromJSON a => FromJSON (Min a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Min a)

FromJSON a => FromJSON (Max a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Max a)

FromJSON a => FromJSON (First a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (First a)

FromJSON a => FromJSON (Last a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Last a)

FromJSON a => FromJSON (First a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (First a)

FromJSON a => FromJSON (Last a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Last a)

FromJSON a => FromJSON (Dual a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Dual a)

FromJSON a => FromJSON (Sum a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Sum a)

FromJSON a => FromJSON (Product a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Product a)

(FromJSON a, Ord a) => FromJSON (Set a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Set a)

(FromJSON l, FromJSON r) => FromJSON (Either l r)

Right-biased: will try to parse a Right value first.

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Either l r)

FromJSON a => FromJSON (Map Text a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f => f (Map Text a)

FromJSON (f a) => FromJSON (Ap f a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f0 => f0 (Ap f a)

FromJSON (f a) => FromJSON (Alt f a)

Defined in Jordan.FromJSON.Class

Methods

fromJSON :: JSONParser f0 => f0 (Alt f a)

data FromJSONOptions

Constructors

FromJSONOptions

Fields

• fromJSONEncodeSums :: SumTypeEncoding
• fromJSONBaseName :: String
• convertEnum :: String -> String

Instances

Generic FromJSONOptions

Defined in Jordan.FromJSON.Class

Associated Types

type Rep FromJSONOptions :: Type -> Type

Methods

from :: FromJSONOptions -> Rep FromJSONOptions x

to :: Rep FromJSONOptions x -> FromJSONOptions

type Rep FromJSONOptions

Defined in Jordan.FromJSON.Class

type Rep FromJSONOptions = D1 ('MetaData "FromJSONOptions" "Jordan.FromJSON.Class" "jordan-0.1.0.0-inplace" 'False) (C1 ('MetaCons "FromJSONOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJSONEncodeSums") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SumTypeEncoding) :*: (S1 ('MetaSel ('Just "fromJSONBaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "convertEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (String -> String)))))

defaultOptions :: FromJSONOptions

addName :: String -> FromJSONOptions -> FromJSONOptions

class GFromJSON v where

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (v a)

Instances

GFromJSON (U1 :: Type -> Type)

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (U1 a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (PartOfSum (l :+: r) a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f0 => FromJSONOptions -> f0 (PartOfSum (C1 t f) a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (PartOfSum (C1 t U1) a)

FromJSON c => GFromJSON (K1 i c :: Type -> Type)

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (K1 i c a)

(Constructor t, Constructor t') => GFromJSON (C1 t (U1 :: Type -> Type) :+: C1 t' (U1 :: Type -> Type))

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f ((C1 t U1 :+: C1 t' U1) a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f ((l :+: r) a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f0 => FromJSONOptions -> f0 (D1 t f a)

Constructor t => GFromJSON (C1 t (U1 :: Type -> Type))

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (C1 t U1 a)

FromJSON s => GFromJSON (C1 c (S1 ('MetaSel ('Nothing :: Maybe Symbol) su ss ds) (Rec0 s)))

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (C1 c (S1 ('MetaSel 'Nothing su ss ds) (Rec0 s)) a)

(GFromJSONObject i, Constructor c) => GFromJSON (C1 c i)

Defined in Jordan.FromJSON.Class

Methods

gFromJSON :: JSONParser f => FromJSONOptions -> f (C1 c i a)

class GFromJSONObject v where

Methods

gFromJSONObject :: JSONObjectParser f => FromJSONOptions -> f (v a)

Instances

GFromJSONObject (U1 :: Type -> Type)

Defined in Jordan.FromJSON.Class

Methods

gFromJSONObject :: JSONObjectParser f => FromJSONOptions -> f (U1 a)

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

Defined in Jordan.FromJSON.Class

Methods

gFromJSONObject :: JSONObjectParser f => FromJSONOptions -> f ((lhs :*: rhs) a)

(FromJSON c, Selector t) => GFromJSONObject (S1 t (K1 v c :: Type -> Type))

Defined in Jordan.FromJSON.Class

Methods

gFromJSONObject :: JSONObjectParser f => FromJSONOptions -> f (S1 t (K1 v c) a)