| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
ByOtherNames.Aeson
Description
A Rubric for JSON serialization using Aeson, along with some helper
newtypes and re-exports.
Required extensions:
- DataKinds
- DeriveGeneric
- DerivingVia
- FlexibleInstances
- MultiParamTypeClasses
- OverloadedStrings
- TypeApplications
- ScopedTypeVariables
Example of use for a record type:
>>>:{data Foo = Foo {aa :: Int, bb :: Bool, cc :: Char} deriving stock (Read, Show, Eq, Generic) deriving (FromJSON, ToJSON) via (JSONRecord "obj" Foo) instance Aliased JSON Foo where aliases = aliasListBegin $ alias @"aa" "aax" $ alias @"bb" "bbx" $ alias @"cc" "ccx" $ aliasListEnd :}
Example of use for a sum type:
>>>:{data Summy = Aa Int | Bb Bool | Cc deriving stock (Read, Show, Eq, Generic) deriving (FromJSON, ToJSON) via (JSONSum "sum" Summy) instance Aliased JSON Summy where aliases = aliasListBegin $ alias @"Aa" "Aax" $ alias @"Bb" "Bbx" $ alias @"Cc" "Ccx" $ aliasListEnd :}
Some observations:
- Fields in branches of sum types can't have selectors. When there is more than one field in a branch, they are parsed as a JSON Array.
- The "object with a single key consisting in the branch tag" style of serialization is used.
Sometimes we have enum-like sum types without any fields, and want to serialize them to simple JSON strings, instead of to objects. In that case, we can do the following:
>>>:{data Enumy = Xx | Yy | Zz deriving stock (Read, Show, Eq, Generic) deriving (FromJSON, ToJSON) via (JSONEnum Enumy) instance Aliased JSON Enumy where aliases = aliasListBegin $ alias @"Xx" "x" $ alias @"Yy" "y" $ alias @"Zz" "z" $ aliasListEnd :}
Synopsis
- data JSONRubric = JSON
- newtype JSONRecord objectName r = JSONRecord r
- newtype JSONSum objectName r = JSONSum r
- newtype JSONEnum r = JSONEnum r
- newtype GeneralJSONRecord rubric objectName r = GeneralJSONRecord r
- newtype GeneralJSONSum rubric objectName r = GeneralJSONSum r
- newtype GeneralJSONEnum rubric r = GeneralJSONEnum r
- class (Rubric k, Generic r) => Aliased k r where
- aliasListBegin :: forall names a rep. AliasTree names rep '[] => AliasList names a -> Aliases rep a
- alias :: forall name a names. a -> AliasList names a -> AliasList (name ': names) a
- aliasListEnd :: AliasList '[] a
- class FromJSON a
- class ToJSON a
JSON helpers
data JSONRubric Source #
Aliases for JSON serialization fall under this Rubric.
The constructor JSON is used as a type, with DataKinds.
Constructors
| JSON |
newtype JSONRecord objectName r Source #
Helper newtype for deriving FromJSON and ToJSON for record types,
using DerivingVia.
The objectName type parameter of kind Symbol is used in parse error messages.
Constructors
| JSONRecord r |
Instances
| (KnownSymbol objectName, Aliased 'JSON r, GRecord FromJSON (Rep r)) => FromJSON (JSONRecord objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods parseJSON :: Value -> Parser (JSONRecord objectName r) # parseJSONList :: Value -> Parser [JSONRecord objectName r] # | |
| (Aliased 'JSON r, GRecord ToJSON (Rep r)) => ToJSON (JSONRecord objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods toJSON :: JSONRecord objectName r -> Value # toEncoding :: JSONRecord objectName r -> Encoding # toJSONList :: [JSONRecord objectName r] -> Value # toEncodingList :: [JSONRecord objectName r] -> Encoding # | |
newtype JSONSum objectName r Source #
Helper newtype for deriving FromJSON and ToJSON for sum types,
using DerivingVia.
The Symbol type parameter is used in parse error messages.
Constructors
| JSONSum r |
Helper newtype for deriving FromJSON and ToJSON for enum-like sum types,
using DerivingVia.
Each constructor is serialized to a JSON string.
Constructors
| JSONEnum r |
Advanced JSON helpers
newtype GeneralJSONRecord rubric objectName r Source #
A more flexible version of JSONRecord that lets you use any Rubric whose
AliasType is Key.
It allows deriving FromJSON and ToJSON for a newtype, using the generic
Rep and the aliases of the underlying type, but without defining
FromJSON and ToJSON instances for the underlying type.
>>>:{data Foo = Foo {aa :: Int, bb :: Bool, cc :: Char} deriving (Read, Show, Eq, Generic) data JSONLocal -- We define a local rubric type to avoid colliding "Aliased" instances over Foo. instance Rubric JSONLocal where type AliasType JSONLocal = Key instance Aliased JSONLocal Foo where aliases = aliasListBegin $ alias @"aa" "aax" $ alias @"bb" "bbx" $ alias @"cc" "ccx" $ aliasListEnd newtype FooN = FooN Foo deriving (FromJSON, ToJSON) via (GeneralJSONRecord JSONLocal "obj" Foo) :}
Constructors
| GeneralJSONRecord r |
Instances
| (KnownSymbol objectName, Rubric rubric2, Aliased rubric2 r, AliasType rubric2 ~ Key, GRecord FromJSON (Rep r)) => FromJSON (GeneralJSONRecord rubric2 objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods parseJSON :: Value -> Parser (GeneralJSONRecord rubric2 objectName r) # parseJSONList :: Value -> Parser [GeneralJSONRecord rubric2 objectName r] # | |
| (Rubric rubric2, Aliased rubric2 r, AliasType rubric2 ~ Key, GRecord ToJSON (Rep r)) => ToJSON (GeneralJSONRecord rubric2 objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods toJSON :: GeneralJSONRecord rubric2 objectName r -> Value # toEncoding :: GeneralJSONRecord rubric2 objectName r -> Encoding # toJSONList :: [GeneralJSONRecord rubric2 objectName r] -> Value # toEncodingList :: [GeneralJSONRecord rubric2 objectName r] -> Encoding # | |
newtype GeneralJSONSum rubric objectName r Source #
A more flexible version of JSONSum that lets you use any Rubric whose
AliasType is Key.
It allows deriving FromJSON and ToJSON for a newtype, using the generic
Rep and the aliases of the underlying type, but without defining
FromJSON and ToJSON instances for the underlying type.
>>>:{data Summy = Aa Int | Bb Bool | Cc deriving (Read, Show, Eq, Generic) data JSONLocal -- We define a local rubric type to avoid colliding "Aliased" instances over Foo. instance Rubric JSONLocal where type AliasType JSONLocal = Key instance Aliased JSONLocal Summy where aliases = aliasListBegin $ alias @"Aa" "Aax" $ alias @"Bb" "Bbx" $ alias @"Cc" "Cc1" $ aliasListEnd newtype SummyN = SummyN Summy deriving (FromJSON, ToJSON) via (GeneralJSONSum JSONLocal "obj" Summy) :}
Constructors
| GeneralJSONSum r |
Instances
| (KnownSymbol objectName, Rubric rubric2, Aliased rubric2 r, AliasType rubric2 ~ Key, GSum FromJSON (Rep r)) => FromJSON (GeneralJSONSum rubric2 objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods parseJSON :: Value -> Parser (GeneralJSONSum rubric2 objectName r) # parseJSONList :: Value -> Parser [GeneralJSONSum rubric2 objectName r] # | |
| (Rubric rubric2, Aliased rubric2 r, AliasType rubric2 ~ Key, GSum ToJSON (Rep r)) => ToJSON (GeneralJSONSum rubric2 objectName r) Source # | |
Defined in ByOtherNames.Aeson Methods toJSON :: GeneralJSONSum rubric2 objectName r -> Value # toEncoding :: GeneralJSONSum rubric2 objectName r -> Encoding # toJSONList :: [GeneralJSONSum rubric2 objectName r] -> Value # toEncodingList :: [GeneralJSONSum rubric2 objectName r] -> Encoding # | |
newtype GeneralJSONEnum rubric r Source #
A more flexible version of JSONEnum that lets you use any Rubric whose
AliasType is Key.
It allows deriving FromJSON and ToJSON for a newtype, using the generic
Rep and the aliases of the underlying type, but without defining
FromJSON and ToJSON instances for the underlying type.
>>>:{data Enumy = Xx | Yy | Zz deriving (Read, Show, Eq, Generic) data JSONLocal -- We define a local rubric type to avoid colliding "Aliased" instances over Enumy. instance Rubric JSONLocal where type AliasType JSONLocal = Key instance Aliased JSONLocal Enumy where aliases = aliasListBegin $ alias @"Xx" "x" $ alias @"Yy" "y" $ alias @"Zz" "z" $ aliasListEnd -- We use the underlying Enumy type in DerivingVia. newtype EnumyN = EnumyN Enumy deriving (FromJSON, ToJSON) via (GeneralJSONEnum JSONLocal Enumy) :}
Constructors
| GeneralJSONEnum r |
Instances
| (Rubric rubric2, AliasType rubric2 ~ Key, Aliased rubric2 r, GSum Impossible (Rep r)) => FromJSON (GeneralJSONEnum rubric2 r) Source # | |
Defined in ByOtherNames.Aeson Methods parseJSON :: Value -> Parser (GeneralJSONEnum rubric2 r) # parseJSONList :: Value -> Parser [GeneralJSONEnum rubric2 r] # | |
| (Rubric rubric2, AliasType rubric2 ~ Key, Aliased rubric2 r, GSum Impossible (Rep r)) => ToJSON (GeneralJSONEnum rubric2 r) Source # | |
Defined in ByOtherNames.Aeson Methods toJSON :: GeneralJSONEnum rubric2 r -> Value # toEncoding :: GeneralJSONEnum rubric2 r -> Encoding # toJSONList :: [GeneralJSONEnum rubric2 r] -> Value # toEncodingList :: [GeneralJSONEnum rubric2 r] -> Encoding # | |
Re-exports from ByOtherNames
class (Rubric k, Generic r) => Aliased k r where Source #
Typeclass for datatypes r that have aliases for some Rubric k.
Arguments
| :: forall names a rep. AliasTree names rep '[] | |
| => AliasList names a | indexed by a list of names |
| -> Aliases rep a | indexed by a generic |
Define the aliases for a type by listing them.
See also alias and aliasListEnd.
The type of the argument is indexed by a list of Symbols, while the
type of the result is indexed by a generic Rep.
Example for a record:
>>>:{data Foo = Foo {aa :: Int, bb :: Bool} deriving (Read, Show, Generic) fieldAliases :: Aliases (Rep Foo) String fieldAliases = aliasListBegin $ alias @"aa" "alias1" $ alias @"bb" "alias2" $ aliasListEnd :}
Example for a sum:
>>>:{data Bar = Aa Int | Bb deriving (Read, Show, Generic) branchAliases :: Aliases (Rep Bar) String branchAliases = aliasListBegin $ alias @"Aa" "alias1" $ alias @"Bb" "alias2" $ aliasListEnd :}
Arguments
| :: forall name a names. a | The alias value |
| -> AliasList names a | |
| -> AliasList (name ': names) a |
Add an alias to an AliasList.
TYPE APPLICATION REQUIRED! You must provide the field/branch name using a type application.
aliasListEnd :: AliasList '[] a Source #
The empty AliasList.
Re-exports from Data.Aeson
A type that can be converted from JSON, with the possibility of failure.
In many cases, you can get the compiler to generate parsing code for you (see below). To begin, let's cover writing an instance by hand.
There are various reasons a conversion could fail. For example, an
Object could be missing a required key, an Array could be of
the wrong size, or a value could be of an incompatible type.
The basic ways to signal a failed conversion are as follows:
failyields a custom error message: it is the recommended way of reporting a failure;empty(ormzero) is uninformative: use it when the error is meant to be caught by some(;<|>)typeMismatchcan be used to report a failure when the encountered value is not of the expected JSON type;unexpectedis an appropriate alternative when more than one type may be expected, or to keep the expected type implicit.
prependFailure (or modifyFailure) add more information to a parser's
error messages.
An example type and instance using typeMismatch and prependFailure:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceFromJSONCoord whereparseJSON(Objectv) = Coord<$>v.:"x"<*>v.:"y" -- We do not expect a non-Objectvalue here. -- We could useemptyto fail, buttypeMismatch-- gives a much more informative error message.parseJSONinvalid =prependFailure"parsing Coord failed, " (typeMismatch"Object" invalid)
For this common case of only being concerned with a single
type of JSON value, the functions withObject, withScientific, etc.
are provided. Their use is to be preferred when possible, since
they are more terse. Using withObject, we can rewrite the above instance
(assuming the same language extension and data type) as:
instanceFromJSONCoord whereparseJSON=withObject"Coord" $ \v -> Coord<$>v.:"x"<*>v.:"y"
Instead of manually writing your FromJSON instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
- The compiler can provide a default generic implementation for
parseJSON.
To use the second, simply add a deriving clause to your
datatype and declare a GenericFromJSON instance for your datatype without giving
a definition for parseJSON.
For example, the previous example can be simplified to just:
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance FromJSON Coord
or using the DerivingVia extension
deriving viaGenericallyCoord instanceFromJSONCoord
The default implementation will be equivalent to
parseJSON = ; if you need different
options, you can customize the generic decoding by defining:genericParseJSON defaultOptions
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceFromJSONCoord whereparseJSON=genericParseJSONcustomOptions
Instances
A type that can be converted to JSON.
Instances in general must specify toJSON and should (but don't need
to) specify toEncoding.
An example type and instance:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceToJSONCoord wheretoJSON(Coord x y) =object["x".=x, "y".=y]toEncoding(Coord x y) =pairs("x".=x<>"y".=y)
Instead of manually writing your ToJSON instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
- The compiler can provide a default generic implementation for
toJSON.
To use the second, simply add a deriving clause to your
datatype and declare a GenericToJSON instance. If you require nothing other than
defaultOptions, it is sufficient to write (and this is the only
alternative where the default toJSON implementation is sufficient):
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance ToJSON Coord where
toEncoding = genericToEncoding defaultOptions
or more conveniently using the DerivingVia extension
deriving viaGenericallyCoord instanceToJSONCoord
If on the other hand you wish to customize the generic decoding, you have to implement both methods:
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceToJSONCoord wheretoJSON=genericToJSONcustomOptionstoEncoding=genericToEncodingcustomOptions
Previous versions of this library only had the toJSON method. Adding
toEncoding had two reasons:
toEncodingis more efficient for the common case that the output oftoJSONis directly serialized to aByteString. Further, expressing either method in terms of the other would be non-optimal.- The choice of defaults allows a smooth transition for existing users:
Existing instances that do not define
toEncodingstill compile and have the correct semantics. This is ensured by making the default implementation oftoEncodingusetoJSON. This produces correct results, but since it performs an intermediate conversion to aValue, it will be less efficient than directly emitting anEncoding. (this also means that specifying nothing more thaninstance ToJSON Coordwould be sufficient as a generically decoding instance, but there probably exists no good reason to not specifytoEncodingin new instances.)