| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Deriving.Aeson
Description
Type-directed aeson instance CustomJSONisation
Synopsis
- newtype CustomJSON t a = CustomJSON {
- unCustomJSON :: a
- data FieldLabelModifier t
- data ConstructorTagModifier t
- data OmitNothingFields
- data RejectUnknownFields
- data TagSingleConstructors
- data NoAllNullaryToStringTag
- data UnwrapUnaryRecords
- data SumTaggedObject t c
- data SumUntaggedValue
- data SumObjectWithSingleField
- data SumTwoElemArray
- data StripPrefix t
- data CamelTo (separator :: Symbol)
- type CamelToKebab = CamelTo "-"
- type CamelToSnake = CamelTo "_"
- data Rename (from :: Symbol) (to :: Symbol)
- class AesonOptions xs where
- class StringModifier t where
- getStringModifier :: String -> String
- class FromJSON a
- class ToJSON a
- class Generic a
Documentation
newtype CustomJSON t a Source #
A newtype wrapper which gives FromJSON/ToJSON instances with modified options.
Constructors
| CustomJSON | |
Fields
| |
Instances
| (AesonOptions t, Generic a, GFromJSON Zero (Rep a)) => FromJSON (CustomJSON t a) Source # | |
Defined in Deriving.Aeson Methods parseJSON :: Value -> Parser (CustomJSON t a) # parseJSONList :: Value -> Parser [CustomJSON t a] # | |
| (AesonOptions t, Generic a, GToJSON Zero (Rep a), GToEncoding Zero (Rep a)) => ToJSON (CustomJSON t a) Source # | |
Defined in Deriving.Aeson Methods toJSON :: CustomJSON t a -> Value # toEncoding :: CustomJSON t a -> Encoding # toJSONList :: [CustomJSON t a] -> Value # toEncodingList :: [CustomJSON t a] -> Encoding # | |
data FieldLabelModifier t Source #
Function applied to field labels. Handy for removing common record prefixes for example.
Instances
| (StringModifier f, AesonOptions xs) => AesonOptions (FieldLabelModifier f ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data ConstructorTagModifier t Source #
Function applied to constructor tags which could be handy for lower-casing them for example.
Instances
| (StringModifier f, AesonOptions xs) => AesonOptions (ConstructorTagModifier f ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data OmitNothingFields Source #
Record fields with a Nothing value will be omitted from the resulting object.
Instances
| AesonOptions xs => AesonOptions (OmitNothingFields ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data RejectUnknownFields Source #
JSON Documents mapped to records with unmatched keys will be rejected
Instances
| AesonOptions xs => AesonOptions (RejectUnknownFields ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data TagSingleConstructors Source #
Encode types with a single constructor as sums, so that allNullaryToStringTag and sumEncoding apply.
Instances
| AesonOptions xs => AesonOptions (TagSingleConstructors ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data NoAllNullaryToStringTag Source #
the encoding will always follow the sumEncoding.
Instances
| AesonOptions xs => AesonOptions (NoAllNullaryToStringTag ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data UnwrapUnaryRecords Source #
Unpack single-field records
Instances
| AesonOptions xs => AesonOptions (UnwrapUnaryRecords ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
Sum encoding
data SumTaggedObject t c Source #
{ "tag": t, "content": c}Instances
| (KnownSymbol t, KnownSymbol c, AesonOptions xs) => AesonOptions (SumTaggedObject t c ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data SumUntaggedValue Source #
CONTENT
Instances
| AesonOptions xs => AesonOptions (SumUntaggedValue ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data SumObjectWithSingleField Source #
{ TAG: CONTENT }Instances
| AesonOptions xs => AesonOptions (SumObjectWithSingleField ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
data SumTwoElemArray Source #
[TAG, CONTENT]
Instances
| AesonOptions xs => AesonOptions (SumTwoElemArray ': xs :: [Type]) Source # | |
Defined in Deriving.Aeson Methods | |
Name modifiers
data StripPrefix t Source #
Strip prefix t. If it doesn't have the prefix, keep it as-is.
Instances
| KnownSymbol k => StringModifier (StripPrefix k :: Type) Source # | |
Defined in Deriving.Aeson Methods getStringModifier :: String -> String Source # | |
data CamelTo (separator :: Symbol) Source #
Generic CamelTo constructor taking in a separator char
Instances
| (KnownSymbol separator, NonEmptyString separator) => StringModifier (CamelTo separator :: Type) Source # | |
Defined in Deriving.Aeson Methods getStringModifier :: String -> String Source # | |
type CamelToKebab = CamelTo "-" Source #
CamelCase to kebab-case
type CamelToSnake = CamelTo "_" Source #
CamelCase to snake_case
data Rename (from :: Symbol) (to :: Symbol) Source #
Rename fields called from to to.
Instances
| (KnownSymbol from, KnownSymbol to) => StringModifier (Rename from to :: Type) Source # | |
Defined in Deriving.Aeson Methods getStringModifier :: String -> String Source # | |
Interface
class AesonOptions xs where Source #
Reify Options from a type-level list
Methods
Instances
class StringModifier t where Source #
Reify a function which modifies names
Methods
getStringModifier :: String -> String Source #
Instances
Reexports
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.)
Instances
Representable types of kind *.
This class is derivable in GHC with the DeriveGeneric flag on.
A Generic instance must satisfy the following laws:
from.to≡idto.from≡id