aeson-2.2.3.0: Fast JSON parsing and encoding

Copyright | (c) 2011-2016 Bryan O'Sullivan (c) 2011 MailRank Inc.
License | BSD3
Maintainer | Bryan O'Sullivan <bos@serpentine.com>
Stability | experimental
Portability | portable
Safe Haskell | None
Language | Haskell2010

Data.Aeson

Contents

- How to use this library
  - Writing instances by hand
  - Working with the AST
  - Decoding to a Haskell value
  - Decoding a mixed-type object
- Encoding and decoding
  - Direct encoding
- Remarks on specific encodings
  - Time
- Main encoding and decoding functions
  - Variants for strict bytestrings
  - Variants for strict text
  - Exception throwing variants
- Core JSON types
- Convenience types
- Type conversion
  - Keys for maps
    - Generic keys
  - Liftings to unary and binary type constructors
  - Generic JSON classes and options
  - Generic and TH encoding configuration
    - Options fields
    - Options utilities
  - Options for object keys
- Inspecting ``Value`s`
- Constructors and accessors
- Parsing

Description

Types and functions for working efficiently with JSON data.

(A note on naming: in Greek mythology, Aeson was the father of Jason.)

Synopsis

- decode :: FromJSON a => ByteString -> Maybe a
- decode' :: FromJSON a => ByteString -> Maybe a
- eitherDecode :: FromJSON a => ByteString -> Either String a
- eitherDecode' :: FromJSON a => ByteString -> Either String a
- encode :: ToJSON a => a -> ByteString
- encodeFile :: ToJSON a => FilePath -> a -> IO ()
- decodeStrict :: FromJSON a => ByteString -> Maybe a
- decodeFileStrict :: FromJSON a => FilePath -> IO (Maybe a)
- decodeStrict' :: FromJSON a => ByteString -> Maybe a
- decodeFileStrict' :: FromJSON a => FilePath -> IO (Maybe a)
- eitherDecodeStrict :: FromJSON a => ByteString -> Either String a
- eitherDecodeFileStrict :: FromJSON a => FilePath -> IO (Either String a)
- eitherDecodeStrict' :: FromJSON a => ByteString -> Either String a
- eitherDecodeFileStrict' :: FromJSON a => FilePath -> IO (Either String a)
- decodeStrictText :: FromJSON a => Text -> Maybe a
- eitherDecodeStrictText :: FromJSON a => Text -> Either String a
- newtype AesonException = AesonException String
- throwDecode :: (FromJSON a, MonadThrow m) => ByteString -> m a
- throwDecodeStrict :: (FromJSON a, MonadThrow m) => ByteString -> m a
- throwDecodeStrictText :: (FromJSON a, MonadThrow m) => Text -> m a
- throwDecode' :: (FromJSON a, MonadThrow m) => ByteString -> m a
- throwDecodeStrict' :: (FromJSON a, MonadThrow m) => ByteString -> m a
- data Value
  - = Object !Object
  - | Array !Array
  - | String !Text
  - | Number !Scientific
  - | Bool !Bool
  - | Null
- type Encoding = Encoding' Value
- fromEncoding :: Encoding' tag -> Builder
- type Array = Vector Value
- type Object = KeyMap Value
- data Key
- newtype DotNetTime = DotNetTime {
  - fromDotNetTime :: UTCTime
  }
- class FromJSON a where
  - parseJSON :: Value -> Parser a
  - parseJSONList :: Value -> Parser [a]
  - omittedField :: Maybe a
- data Result a
  - = Error String
  - | Success a
- fromJSON :: FromJSON a => Value -> Result a
- class ToJSON a where
  - toJSON :: a -> Value
  - toEncoding :: a -> Encoding
  - toJSONList :: [a] -> Value
  - toEncodingList :: [a] -> Encoding
  - omitField :: a -> Bool
- class KeyValue e kv | kv -> e where
  - (.=) :: ToJSON v => Key -> v -> kv
  - explicitToField :: (v -> e) -> Key -> v -> kv
- class KeyValue e kv => KeyValueOmit e kv | kv -> e where
  - (.?=) :: ToJSON v => Key -> v -> kv
  - explicitToFieldOmit :: (v -> Bool) -> (v -> e) -> Key -> v -> kv
- (<?>) :: Parser a -> JSONPathElement -> Parser a
- type JSONPath = [JSONPathElement]
- class ToJSONKey a where
  - toJSONKey :: ToJSONKeyFunction a
  - toJSONKeyList :: ToJSONKeyFunction [a]
- data ToJSONKeyFunction a
  - = ToJSONKeyText !(a -> Key) !(a -> Encoding' Key)
  - | ToJSONKeyValue !(a -> Value) !(a -> Encoding)
- class FromJSONKey a where
  - fromJSONKey :: FromJSONKeyFunction a
  - fromJSONKeyList :: FromJSONKeyFunction [a]
- data FromJSONKeyFunction a where
  - FromJSONKeyCoerce :: forall a. Coercible Text a => FromJSONKeyFunction a
  - FromJSONKeyText :: forall a. !(Text -> a) -> FromJSONKeyFunction a
  - FromJSONKeyTextParser :: forall a. !(Text -> Parser a) -> FromJSONKeyFunction a
  - FromJSONKeyValue :: forall a. !(Value -> Parser a) -> FromJSONKeyFunction a
- class GetConName f => GToJSONKey (f :: k -> Type)
- genericToJSONKey :: (Generic a, GToJSONKey (Rep a)) => JSONKeyOptions -> ToJSONKeyFunction a
- class (ConstructorNames f, SumFromString f) => GFromJSONKey (f :: Type -> Type)
- genericFromJSONKey :: (Generic a, GFromJSONKey (Rep a)) => JSONKeyOptions -> FromJSONKeyFunction a
- class FromJSON1 (f :: Type -> Type) where
  - liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a)
  - liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [f a]
  - liftOmittedField :: Maybe a -> Maybe (f a)
- parseJSON1 :: (FromJSON1 f, FromJSON a) => Value -> Parser (f a)
- omittedField1 :: (FromJSON1 f, FromJSON a) => Maybe (f a)
- class FromJSON2 (f :: Type -> Type -> Type) where
  - liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (f a b)
  - liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [f a b]
  - liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (f a b)
- parseJSON2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Value -> Parser (f a b)
- omittedField2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Maybe (f a b)
- class ToJSON1 (f :: Type -> Type) where
  - liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> f a -> Value
  - liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [f a] -> Value
  - liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> f a -> Encoding
  - liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [f a] -> Encoding
  - liftOmitField :: (a -> Bool) -> f a -> Bool
- toJSON1 :: (ToJSON1 f, ToJSON a) => f a -> Value
- toEncoding1 :: (ToJSON1 f, ToJSON a) => f a -> Encoding
- omitField1 :: (ToJSON1 f, ToJSON a) => f a -> Bool
- class ToJSON2 (f :: Type -> Type -> Type) where
  - liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> f a b -> Value
  - liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [f a b] -> Value
  - liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> f a b -> Encoding
  - liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [f a b] -> Encoding
  - liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> f a b -> Bool
- toJSON2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Value
- toEncoding2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Encoding
- omitField2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Bool
- class GFromJSON arity (f :: Type -> Type)
- data FromArgs arity a
- type GToJSON = GToJSON' Value
- type GToEncoding = GToJSON' Encoding
- class GToJSON' enc arity (f :: Type -> Type)
- data ToArgs res arity a
- data Zero
- data One
- genericToJSON :: (Generic a, GToJSON' Value Zero (Rep a)) => Options -> a -> Value
- genericLiftToJSON :: (Generic1 f, GToJSON' Value One (Rep1 f)) => Options -> (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> f a -> Value
- genericToEncoding :: (Generic a, GToJSON' Encoding Zero (Rep a)) => Options -> a -> Encoding
- genericLiftToEncoding :: (Generic1 f, GToJSON' Encoding One (Rep1 f)) => Options -> (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> f a -> Encoding
- genericParseJSON :: (Generic a, GFromJSON Zero (Rep a)) => Options -> Value -> Parser a
- genericLiftParseJSON :: (Generic1 f, GFromJSON One (Rep1 f)) => Options -> Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a)
- data Options
- defaultOptions :: Options
- fieldLabelModifier :: Options -> String -> String
- constructorTagModifier :: Options -> String -> String
- allNullaryToStringTag :: Options -> Bool
- omitNothingFields :: Options -> Bool
- allowOmittedFields :: Options -> Bool
- sumEncoding :: Options -> SumEncoding
- unwrapUnaryRecords :: Options -> Bool
- tagSingleConstructors :: Options -> Bool
- rejectUnknownFields :: Options -> Bool
- data SumEncoding
  - = TaggedObject {
    - tagFieldName :: String
    - contentsFieldName :: String
    }
  - | UntaggedValue
  - | ObjectWithSingleField
  - | TwoElemArray
- camelTo2 :: Char -> String -> String
- defaultTaggedObject :: SumEncoding
- data JSONKeyOptions
- keyModifier :: JSONKeyOptions -> String -> String
- defaultJSONKeyOptions :: JSONKeyOptions
- withObject :: String -> (Object -> Parser a) -> Value -> Parser a
- withText :: String -> (Text -> Parser a) -> Value -> Parser a
- withArray :: String -> (Array -> Parser a) -> Value -> Parser a
- withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a
- withBool :: String -> (Bool -> Parser a) -> Value -> Parser a
- withEmbeddedJSON :: String -> (Value -> Parser a) -> Value -> Parser a
- data Series
- pairs :: Series -> Encoding
- foldable :: (Foldable t, ToJSON a) => t a -> Encoding
- (.:) :: FromJSON a => Object -> Key -> Parser a
- (.:?) :: FromJSON a => Object -> Key -> Parser (Maybe a)
- (.:!) :: FromJSON a => Object -> Key -> Parser (Maybe a)
- (.!=) :: Parser (Maybe a) -> a -> Parser a
- (.:?=) :: FromJSON a => Object -> Key -> Parser a
- (.:!=) :: FromJSON a => Object -> Key -> Parser a
- object :: [Pair] -> Value
- parseIndexedJSON :: (Value -> Parser a) -> Int -> Value -> Parser a

# How to use this library

This section contains basic information on the different ways to work with data using this library. These range from simple but inflexible, to complex but flexible.

The most common way to use the library is to define a data type, corresponding to some JSON data you want to work with, and then write either a `FromJSON` instance, a `ToJSON` instance, or both for that type.

For example, given this JSON data:

    { "name": "Joe", "age": 12 }

we create a matching data type:

    {-# LANGUAGE DeriveGeneric #-}

    import GHC.Generics

    data Person = Person {
          name :: Text
        , age  :: Int
        } deriving (Generic, Show)

The `LANGUAGE` pragma and `Generic` instance let us write empty `FromJSON` and `ToJSON` instances for which the compiler will generate sensible default implementations.

    instance ToJSON Person where
        -- No need to provide a toJSON implementation.

        -- For efficiency, we write a simple toEncoding implementation, as
        -- the default version uses toJSON.
        toEncoding = genericToEncoding defaultOptions

    instance FromJSON Person
        -- No need to provide a parseJSON implementation.

We can now encode a value like so:

    >>> encode (Person {name = "Joe", age = 12})
    "{\"name\":\"Joe\",\"age\":12}"

## Writing instances by hand

When necessary, we can write `ToJSON` and `FromJSON` instances by hand. This is valuable when the JSON-on-the-wire and Haskell data are different or otherwise need some more carefully managed translation. Let's revisit our JSON data:

    { "name": "Joe", "age": 12 }

We once again create a matching data type, without bothering to add a `Generic` instance this time:

    data Person = Person {
          name :: Text
        , age  :: Int
        } deriving Show

To decode data, we need to define a `FromJSON` instance:

    {-# LANGUAGE OverloadedStrings #-}

    instance FromJSON Person where
        parseJSON = withObject "Person" $ \v -> Person
            <$> v .: "name"
            <*> v .: "age"

We can now parse the JSON data like so:

    >>> decode "{\"name\":\"Joe\",\"age\":12}" :: Maybe Person
    Just (Person {name = "Joe", age = 12})

To encode data, we need to define a `ToJSON` instance. Let's begin with an instance written entirely by hand.

    instance ToJSON Person where
        -- this generates a Value
        toJSON (Person name age) =
            object ["name" .= name, "age" .= age]

        -- this encodes directly to a bytestring Builder
        toEncoding (Person name age) =
            pairs ("name" .= name <> "age" .= age)

We can now encode a value like so:

    >>> encode (Person {name = "Joe", age = 12})
    "{\"name\":\"Joe\",\"age\":12}"

There are predefined `FromJSON` and `ToJSON` instances for many types. Here's an example using lists and `Int`s:

    >>> decode "[1,2,3]" :: Maybe [Int]
    Just [1,2,3]

And here's an example using the `Map` type to get a map of `Int`s.

    >>> decode "{\"foo\":1,\"bar\":2}" :: Maybe (Map String Int)
    Just (fromList [("bar",2),("foo",1)])

## Working with the AST

Sometimes you want to work with JSON data directly, without first converting it to a custom data type. This can be useful if you want to e.g. convert JSON data to YAML data, without knowing what the contents of the original JSON data was. The `Value` type, which is an instance of `FromJSON`, is used to represent an arbitrary JSON AST (abstract syntax tree). Example usage:

    >>> decode "{\"foo\": 123}" :: Maybe Value
    Just (Object (fromList [("foo",Number 123)]))

    >>> decode "{\"foo\": [\"abc\",\"def\"]}" :: Maybe Value
    Just (Object (fromList [("foo",Array (fromList [String "abc",String "def"]))]))

Once you have a `Value` you can write functions to traverse it and make arbitrary transformations.

## Decoding to a Haskell value

We can decode to any instance of `FromJSON`:

    λ> decode "[1,2,3]" :: Maybe [Int]
    Just [1,2,3]

Alternatively, there are instances for standard data types, so you can use them directly. For example, use the `Map` type to get a map of `Int`s.

    λ> import Data.Map
    λ> decode "{\"foo\":1,\"bar\":2}" :: Maybe (Map String Int)
    Just (fromList [("bar",2),("foo",1)])

## Decoding a mixed-type object

The above approach with maps of course will not work for mixed-type objects that don't follow a strict schema, but there are a couple of approaches available for these.

The `Object` type contains JSON objects:

    λ> decode "{\"name\":\"Dave\",\"age\":2}" :: Maybe Object
    Just (fromList [("name",String "Dave"),("age",Number 2)])

You can extract values from it with a parser using `parse`, `parseEither` or, in this example, `parseMaybe`:

    λ> do result <- decode "{\"name\":\"Dave\",\"age\":2}"
          flip parseMaybe result $ \obj -> do
            age <- obj .: "age"
            name <- obj .: "name"
            return (name ++ ": " ++ show (age*2))

    Just "Dave: 4"

Considering that any type that implements `FromJSON` can be used here, this is quite a powerful way to parse JSON. See the documentation in `FromJSON` for how to implement this class for your own data types.

The downside is that you have to write the parser yourself; the upside is that you have complete control over the way the JSON is parsed.

# Encoding and decoding

Decoding is a two-step process.

- When decoding a value, the process is reversed: the bytes are converted to a `Value`, then the `FromJSON` class is used to convert to the desired type.

There are two ways to encode a value.

- Convert to a `Value` using `toJSON`, then possibly further encode. This was the only method available in aeson 0.9 and earlier.
- Directly encode (to what will become a `ByteString`) using `toEncoding`. This is much more efficient (about 3x faster, and less memory intensive besides), but is only available in aeson 0.10 and newer.

For convenience, the `encode` and `decode` functions combine both steps.

## Direct encoding

In older versions of this library, encoding a Haskell value involved converting to an intermediate `Value`, then encoding that.

A "direct" encoder converts straight from a source Haskell value to a `ByteString` without constructing an intermediate `Value`. This approach is faster than `toJSON`, and allocates less memory. The `toEncoding` method makes it possible to implement direct encoding with low memory overhead.

To complicate matters, the default implementation of `toEncoding` uses `toJSON`. Why? The `toEncoding` method was added to this library much more recently than `toJSON`. Using `toJSON` ensures that packages written against older versions of this library will compile and produce correct output, but they will not see any speedup from direct encoding.

To write a minimal implementation of direct encoding, your type must implement GHC's `Generic` class, and your code should look like this:

        toEncoding = genericToEncoding defaultOptions

What if you have more elaborate encoding needs? For example, perhaps you need to change the names of object keys, omit parts of a value.

To encode to a JSON "object", use the `pairs` function.

        toEncoding (Person name age) =
            pairs ("name" .= name <> "age" .= age)

Any container type that implements `Foldable` can be encoded to a JSON "array" using `foldable`.

    > import Data.Sequence as Seq
    > encode (Seq.fromList [1,2,3])
    "[1,2,3]"

# Remarks on specific encodings

## Time

This module contains instances of `ToJSON` and `FromJSON` for types from the time library.

Those instances encode time as JSON strings in ISO 8601 formats, with the following general form for `UTCTime` and `ZonedTime`, while other time types use subsets of those fields:

    [+,-]YYYY-MM-DDThh:mm[:ss[.sss]]Z

where

- `[+,-]` is an optional sign, `+` or `-`.
- `YYYY` is the year, which must have at least 4 digits to prevent Y2K problems. Years from `0000` to `0999` must thus be zero-padded.
- `MM` is a two-digit month.
- `DD` is a two-digit day.
- `T` is a literal `'T'` character separating the date and the time of day. It may be a space instead.
- `hh` is a two-digit hour.
- `mm` is a two-digit minute.
- `ss` is a two-digit second.
- `sss` is a decimal fraction of a second; it may have any nonzero number of digits.
- `Z` is a time zone; it may be preceded by an optional space.

For more information, see ISO 8601 time, and text-iso8601 (where the relevant parsers are defined).

# Main encoding and decoding functions

decode :: FromJSON a => ByteString -> Maybe a Source #

Efficiently deserialize a JSON value from a lazy `ByteString`. If this fails due to incomplete or invalid input, `Nothing` is returned.

decode' :: FromJSON a => ByteString -> Maybe a Source #

Efficiently deserialize a JSON value from a lazy `ByteString`. If this fails due to incomplete or invalid input, `Nothing` is returned.

Since `2.2.0.0` an alias for `decode`.

eitherDecode :: FromJSON a => ByteString -> Either String a Source #

Like `decode` but returns an error message when decoding fails.

eitherDecode' :: FromJSON a => ByteString -> Either String a Source #

Like `decode'` but returns an error message when decoding fails.

Since `2.2.0.0` an alias for `eitherDecode`.

encode :: ToJSON a => a -> ByteString Source #

Efficiently serialize a JSON value as a lazy `ByteString`.

This is implemented in terms of the `ToJSON` class's `toEncoding` method.

encodeFile :: ToJSON a => FilePath -> a -> IO () Source #

Efficiently serialize a JSON value as a lazy `ByteString` and write it to a file.

## Variants for strict bytestrings

decodeStrict :: FromJSON a => ByteString -> Maybe a Source #

Efficiently deserialize a JSON value from a strict `ByteString`. If this fails due to incomplete or invalid input, `Nothing` is returned.

decodeFileStrict :: FromJSON a => FilePath -> IO (Maybe a) Source #

Efficiently deserialize a JSON value from a file. If this fails due to incomplete or invalid input, `Nothing` is returned.

The input file's content must consist solely of a JSON document, with no trailing data except for whitespace.

This function parses immediately, but defers conversion. See `json` for details.

decodeStrict' :: FromJSON a => ByteString -> Maybe a Source #

Efficiently deserialize a JSON value from a strict `ByteString`. If this fails due to incomplete or invalid input, `Nothing` is returned.

Since `2.2.0.0` an alias for `decodeStrict`.

decodeFileStrict' :: FromJSON a => FilePath -> IO (Maybe a) Source #

Efficiently deserialize a JSON value from a file. If this fails due to incomplete or invalid input, `Nothing` is returned.

Since `2.2.0.0` an alias for `decodeFileStrict`.

eitherDecodeStrict :: FromJSON a => ByteString -> Either String a Source #

Like `decodeStrict` but returns an error message when decoding fails.

eitherDecodeFileStrict :: FromJSON a => FilePath -> IO (Either String a) Source #

Like `decodeFileStrict` but returns an error message when decoding fails.

eitherDecodeStrict' :: FromJSON a => ByteString -> Either String a Source #

Like `decodeStrict'` but returns an error message when decoding fails.

Since `2.2.0.0` an alias for `eitherDecodeStrict`.

eitherDecodeFileStrict' :: FromJSON a => FilePath -> IO (Either String a) Source #

Like `decodeFileStrict'` but returns an error message when decoding fails.

Since `2.2.0.0` an alias for `eitherDecodeFileStrict'`.

## Variants for strict text

decodeStrictText :: FromJSON a => Text -> Maybe a Source #

Efficiently deserialize a JSON value from a strict `Text`. If this fails due to incomplete or invalid input, `Nothing` is returned.

Since: 2.2.1.0

eitherDecodeStrictText :: FromJSON a => Text -> Either String a Source #

Like `decodeStrictText` but returns an error message when decoding fails.

Since: 2.2.1.0

## Exception throwing variants

newtype AesonException Source #

Exception thrown by `throwDecode` and variants.

Since: 2.1.2.0

Constructors

AesonException String |

#### Instances

Instances details

Exception AesonException Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods toException :: AesonException -> SomeException Source # fromException :: SomeException -> Maybe AesonException Source # displayException :: AesonException -> String Source # backtraceDesired :: AesonException -> Bool Source #
Show AesonException Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> AesonException -> ShowS Source # show :: AesonException -> String Source # showList :: [AesonException] -> ShowS Source #

throwDecode :: (FromJSON a, MonadThrow m) => ByteString -> m a Source #

Like `decode` but throws an `AesonException` when decoding fails.

`throwDecode` is in `aeson` since 2.1.2.0, but this variant is added later.

throwDecodeStrict :: (FromJSON a, MonadThrow m) => ByteString -> m a Source #

Like `decodeStrict` but throws an `AesonException` when decoding fails.

throwDecodeStrictText :: (FromJSON a, MonadThrow m) => Text -> m a Source #

Like `decodeStrictText` but throws an `AesonException` when decoding fails.

Since: 2.2.1.0

throwDecode' :: (FromJSON a, MonadThrow m) => ByteString -> m a Source #

Like `decode'` but throws an `AesonException` when decoding fails.

Since `2.2.0.0` an alias for `throwDecode`.

Since: 2.1.2.0

throwDecodeStrict' :: (FromJSON a, MonadThrow m) => ByteString -> m a Source #

Like `decodeStrict'` but throws an `AesonException` when decoding fails.

Since `2.2.0.0` an alias for `throwDecodeStrict`.

Since: 2.1.2.0

# Core JSON types

data Value Source #

A JSON value represented as a Haskell value.

Constructors

Object !Object |
Array !Array |
String !Text |
Number !Scientific |
Bool !Bool |
Null |

#### Instances

Instances details

Arbitrary Value Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Types.Internal Methods arbitrary :: Gen Value Source # shrink :: Value -> [Value] Source #
CoArbitrary Value Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Types.Internal Methods coarbitrary :: Value -> Gen b -> Gen b Source #
Function Value Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Types.Internal Methods function :: (Value -> b) -> Value :-> b Source #
FromJSON Value Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Value Source # parseJSONList :: Value -> Parser [Value] Source # omittedField :: Maybe Value Source #
ToJSON Value Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Value -> Value Source # toEncoding :: Value -> Encoding Source # toJSONList :: [Value] -> Value Source # toEncodingList :: [Value] -> Encoding Source # omitField :: Value -> Bool Source #
NFData Value Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods rnf :: Value -> () Source #
Data Value Source # |

Instance details

Defined in Data.Aeson.Types.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value Source #

toConstr :: Value -> Constr Source #

dataTypeOf :: Value -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) Source #

gmapT :: (forall b. Data b => b -> b) -> Value -> Value Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value Source #

IsString Value Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods fromString :: String -> Value Source #
Generic Value Source # |

Instance details

Defined in Data.Aeson.Types.Internal

Associated Types

type Rep Value |

Instance details

Defined in Data.Aeson.Types.Internal

type Rep Value = D1 ('MetaData "Value" "Data.Aeson.Types.Internal" "aeson-2.2.3.0-9nPAODfuQseImfLzwWGeav" 'False) ((C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object)) :+: (C1 ('MetaCons "Array" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Array)) :+: C1 ('MetaCons "String" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "Bool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "Null" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: Value -> Rep Value x Source #

to :: Rep Value x -> Value Source #

Read Value Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods readsPrec :: Int -> ReadS Value Source # readList :: ReadS [Value] Source # readPrec :: ReadPrec Value Source # readListPrec :: ReadPrec [Value] Source #

Show Value Source #

Since version 1.5.6.0 version object values are printed in lexicographic key order

    >>> toJSON $ H.fromList [("a", True), ("z", False)]
    Object (fromList [("a",Bool True),("z",Bool False)])

    >>> toJSON $ H.fromList [("z", False), ("a", True)]
    Object (fromList [("a",Bool True),("z",Bool False)])

Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> Value -> ShowS Source # show :: Value -> String Source # showList :: [Value] -> ShowS Source #
Eq Value Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (==) :: Value -> Value -> Bool Source # (/=) :: Value -> Value -> Bool Source #
Ord Value Source # | The ordering is total, consistent with `Eq` instance. However, nothing else about the ordering is specified, and it may change from environment to environment and version to version of either this package or its dependencies (`hashable` and 'unordered-containers'). Since: 1.5.2.0
Instance details Defined in Data.Aeson.Types.Internal Methods compare :: Value -> Value -> Ordering Source # (<) :: Value -> Value -> Bool Source # (<=) :: Value -> Value -> Bool Source # (>) :: Value -> Value -> Bool Source # (>=) :: Value -> Value -> Bool Source # max :: Value -> Value -> Value Source # min :: Value -> Value -> Value Source #
Hashable Value Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods hashWithSalt :: Int -> Value -> Int Source # hash :: Value -> Int Source #
KeyValue Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> Series Source # explicitToField :: (v -> Encoding) -> Key -> v -> Series Source #
KeyValueOmit Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.?=) :: ToJSON v => Key -> v -> Series Source # explicitToFieldOmit :: (v -> Bool) -> (v -> Encoding) -> Key -> v -> Series Source #
Lift Value Source # | Since: 0.11.0.0
Instance details Defined in Data.Aeson.Types.Internal Methods lift :: Quote m => Value -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => Value -> Code m Value Source #
GToJSON' Encoding arity (U1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a -> U1 a -> Encoding
GToJSON' Encoding arity (V1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a -> V1 a -> Encoding
GToJSON' Value arity (U1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a -> U1 a -> Value
GToJSON' Value arity (V1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a -> V1 a -> Value
ToJSON1 f => GToJSON' Encoding One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> Rec1 f a -> Encoding
ToJSON1 f => GToJSON' Value One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> Rec1 f a -> Value
(EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a0 -> (a :*: b) a0 -> Encoding
ToJSON a => GToJSON' Encoding arity (K1 i a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a0 -> K1 i a a0 -> Encoding
(WriteProduct arity a, WriteProduct arity b, ProductSize a, ProductSize b) => GToJSON' Value arity (a :*: b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a0 -> (a :*: b) a0 -> Value
ToJSON a => GToJSON' Value arity (K1 i a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a0 -> K1 i a a0 -> Value
(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> (f :.: g) a -> Encoding
(ToJSON1 f, GToJSON' Value One g) => GToJSON' Value One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> (f :.: g) a -> Value
value ~ Value => KeyValue Value (KeyMap value) Source # | Constructs a singleton `KeyMap`. For calling functions that demand an `Object` for constructing objects. To be used in conjunction with `mconcat`. Prefer to use `object` where possible.
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> KeyMap value Source # explicitToField :: (v -> Value) -> Key -> v -> KeyMap value Source #
value ~ Value => KeyValueOmit Value (KeyMap value) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.?=) :: ToJSON v => Key -> v -> KeyMap value Source # explicitToFieldOmit :: (v -> Bool) -> (v -> Value) -> Key -> v -> KeyMap value Source #
(key ~ Key, value ~ Value) => KeyValue Value (key, value) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> (key, value) Source # explicitToField :: (v -> Value) -> Key -> v -> (key, value) Source #
type Rep Value Source # |

Instance details

Defined in Data.Aeson.Types.Internal

type Rep Value = D1 ('MetaData "Value" "Data.Aeson.Types.Internal" "aeson-2.2.3.0-9nPAODfuQseImfLzwWGeav" 'False) ((C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object)) :+: (C1 ('MetaCons "Array" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Array)) :+: C1 ('MetaCons "String" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "Bool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "Null" 'PrefixI 'False) (U1 :: Type -> Type))))

type Encoding = Encoding' Value Source #

Often used synonym for `Encoding'`.

fromEncoding :: Encoding' tag -> Builder Source #

Acquire the underlying bytestring builder.

type Array = Vector Value Source #

A JSON "array" (sequence).

type Object = KeyMap Value Source #

A JSON "object" (key/value map).

data Key Source #

#### Instances

Instances details

Arbitrary Key Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Key Methods arbitrary :: Gen Key Source # shrink :: Key -> [Key] Source #
CoArbitrary Key Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Key Methods coarbitrary :: Key -> Gen b -> Gen b Source #
Function Key Source # | Since: 2.0.3.0
Instance details Defined in Data.Aeson.Key Methods function :: (Key -> b) -> Key :-> b Source #
FromJSON Key Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Key Source # parseJSONList :: Value -> Parser [Key] Source # omittedField :: Maybe Key Source #
FromJSONKey Key Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Key Source # fromJSONKeyList :: FromJSONKeyFunction [Key] Source #
ToJSON Key Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Key -> Value Source # toEncoding :: Key -> Encoding Source # toJSONList :: [Key] -> Value Source # toEncodingList :: [Key] -> Encoding Source # omitField :: Key -> Bool Source #
ToJSONKey Key Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Key Source # toJSONKeyList :: ToJSONKeyFunction [Key] Source #
NFData Key Source # |
Instance details Defined in Data.Aeson.Key Methods rnf :: Key -> () Source #
Monoid Key Source # |
Instance details Defined in Data.Aeson.Key Methods mempty :: Key Source # mappend :: Key -> Key -> Key Source # mconcat :: [Key] -> Key Source #
Semigroup Key Source # |
Instance details Defined in Data.Aeson.Key Methods (<>) :: Key -> Key -> Key Source # sconcat :: NonEmpty Key -> Key Source # stimes :: Integral b => b -> Key -> Key Source #
Data Key Source # |

Instance details

Defined in Data.Aeson.Key

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Key -> c Key Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Key Source #

toConstr :: Key -> Constr Source #

dataTypeOf :: Key -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Key) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Key) Source #

gmapT :: (forall b. Data b => b -> b) -> Key -> Key Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> Key -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Key -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Key -> m Key Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key Source #

IsString Key Source # |
Instance details Defined in Data.Aeson.Key Methods fromString :: String -> Key Source #
Read Key Source # |
Instance details Defined in Data.Aeson.Key Methods readsPrec :: Int -> ReadS Key Source # readList :: ReadS [Key] Source # readPrec :: ReadPrec Key Source # readListPrec :: ReadPrec [Key] Source #
Show Key Source # |
Instance details Defined in Data.Aeson.Key Methods showsPrec :: Int -> Key -> ShowS Source # show :: Key -> String Source # showList :: [Key] -> ShowS Source #
Eq Key Source # |
Instance details Defined in Data.Aeson.Key Methods (==) :: Key -> Key -> Bool Source # (/=) :: Key -> Key -> Bool Source #
Ord Key Source # |
Instance details Defined in Data.Aeson.Key Methods compare :: Key -> Key -> Ordering Source # (<) :: Key -> Key -> Bool Source # (<=) :: Key -> Key -> Bool Source # (>) :: Key -> Key -> Bool Source # (>=) :: Key -> Key -> Bool Source # max :: Key -> Key -> Key Source # min :: Key -> Key -> Key Source #
Hashable Key Source # |
Instance details Defined in Data.Aeson.Key Methods hashWithSalt :: Int -> Key -> Int Source # hash :: Key -> Int Source #
FoldableWithIndex Key KeyMap Source # |

Instance details

Defined in Data.Aeson.KeyMap

Methods

ifoldMap :: Monoid m => (Key -> a -> m) -> KeyMap a -> m Source #

ifoldMap' :: Monoid m => (Key -> a -> m) -> KeyMap a -> m Source #

ifoldr :: (Key -> a -> b -> b) -> b -> KeyMap a -> b Source #

ifoldl :: (Key -> b -> a -> b) -> b -> KeyMap a -> b Source #

ifoldr' :: (Key -> a -> b -> b) -> b -> KeyMap a -> b Source #

ifoldl' :: (Key -> b -> a -> b) -> b -> KeyMap a -> b Source #

FunctorWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods imap :: (Key -> a -> b) -> KeyMap a -> KeyMap b Source #
TraversableWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods itraverse :: Applicative f => (Key -> a -> f b) -> KeyMap a -> f (KeyMap b) Source #
SemialignWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods ialignWith :: (Key -> These a b -> c) -> KeyMap a -> KeyMap b -> KeyMap c Source #
ZipWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods izipWith :: (Key -> a -> b -> c) -> KeyMap a -> KeyMap b -> KeyMap c Source #
Lift Key Source # |
Instance details Defined in Data.Aeson.Key Methods lift :: Quote m => Key -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => Key -> Code m Key Source #
FilterableWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods imapMaybe :: (Key -> a -> Maybe b) -> KeyMap a -> KeyMap b Source # ifilter :: (Key -> a -> Bool) -> KeyMap a -> KeyMap a Source #
WitherableWithIndex Key KeyMap Source # |
Instance details Defined in Data.Aeson.KeyMap Methods iwither :: Applicative f => (Key -> a -> f (Maybe b)) -> KeyMap a -> f (KeyMap b) Source # iwitherM :: Monad m => (Key -> a -> m (Maybe b)) -> KeyMap a -> m (KeyMap b) Source # ifilterA :: Applicative f => (Key -> a -> f Bool) -> KeyMap a -> f (KeyMap a) Source #

# Convenience types

newtype DotNetTime Source #

A newtype wrapper for `UTCTime` that uses the same non-standard serialization format as Microsoft .NET, whose System.DateTime type is by default serialized to JSON as in the following example:

    /Date(1302547608878)/

The number represents milliseconds since the Unix epoch.

Constructors

DotNetTime |

Fields

- fromDotNetTime :: UTCTime

  Acquire the underlying value.

#### Instances

Instances details

FromJSON DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser DotNetTime Source # parseJSONList :: Value -> Parser [DotNetTime] Source # omittedField :: Maybe DotNetTime Source #
ToJSON DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DotNetTime -> Value Source # toEncoding :: DotNetTime -> Encoding Source # toJSONList :: [DotNetTime] -> Value Source # toEncodingList :: [DotNetTime] -> Encoding Source # omitField :: DotNetTime -> Bool Source #
Read DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods readsPrec :: Int -> ReadS DotNetTime Source # readList :: ReadS [DotNetTime] Source # readPrec :: ReadPrec DotNetTime Source # readListPrec :: ReadPrec [DotNetTime] Source #
Show DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> DotNetTime -> ShowS Source # show :: DotNetTime -> String Source # showList :: [DotNetTime] -> ShowS Source #
Eq DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (==) :: DotNetTime -> DotNetTime -> Bool Source # (/=) :: DotNetTime -> DotNetTime -> Bool Source #
Ord DotNetTime Source # |

Instance details

Defined in Data.Aeson.Types.Internal

Methods

compare :: DotNetTime -> DotNetTime -> Ordering Source #

(<) :: DotNetTime -> DotNetTime -> Bool Source #

(<=) :: DotNetTime -> DotNetTime -> Bool Source #

(>) :: DotNetTime -> DotNetTime -> Bool Source #

(>=) :: DotNetTime -> DotNetTime -> Bool Source #

max :: DotNetTime -> DotNetTime -> DotNetTime Source #

min :: DotNetTime -> DotNetTime -> DotNetTime Source #

FormatTime DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods formatCharacter :: Bool -> Char -> Maybe (FormatOptions -> DotNetTime -> String) Source #

# Type conversion

class FromJSON a where Source #

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:

- `fail` yields a custom error message: it is the recommended way of reporting a failure;
- `empty` (or `mzero`) is uninformative: use it when the error is meant to be caught by some `(`<|>`)`;
- `typeMismatch` can be used to report a failure when the encountered value is not of the expected JSON type; `unexpected` is 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 write Text literals.
    {-# LANGUAGE OverloadedStrings #-}

    data Coord = Coord { x :: Double, y :: Double }

    instance FromJSON Coord where
        parseJSON (Object v) = Coord
            <$> v .: "x"
            <*> v .: "y"

        -- We do not expect a non-Object value here.
        -- We could use empty to fail, but typeMismatch
        -- gives a much more informative error message.
        parseJSON invalid    =
            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:

    instance FromJSON Coord where
        parseJSON = 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 `Generic`` clause to your datatype and declare a `FromJSON` 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 via Generically Coord instance FromJSON Coord

The default implementation will be equivalent to `parseJSON = `genericParseJSON` `defaultOptions``; if you need different options, you can customize the generic decoding by defining:

    customOptions = defaultOptions
                    { fieldLabelModifier = map toUpper
                    }

    instance FromJSON Coord where
        parseJSON = genericParseJSON customOptions

Minimal complete definition

Nothing

Methods

parseJSON :: Value -> Parser a Source #

default parseJSON :: (Generic a, GFromJSON Zero (Rep a)) => Value -> Parser a Source #

parseJSONList :: Value -> Parser [a] Source #

omittedField :: Maybe a Source #

Default value for optional fields. Used by `(`.:?=`)` operator, and Generics and TH deriving with ``allowOmittedFields` = True` (default).

Since: 2.2.0.0

#### Instances

Instances details

FromJSON Key Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Key Source # parseJSONList :: Value -> Parser [Key] Source # omittedField :: Maybe Key Source #
FromJSON DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser DotNetTime Source # parseJSONList :: Value -> Parser [DotNetTime] Source # omittedField :: Maybe DotNetTime Source #
FromJSON Value Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Value Source # parseJSONList :: Value -> Parser [Value] Source # omittedField :: Maybe Value Source #
FromJSON IntSet Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser IntSet Source # parseJSONList :: Value -> Parser [IntSet] Source # omittedField :: Maybe IntSet Source #
FromJSON Void Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Void Source # parseJSONList :: Value -> Parser [Void] Source # omittedField :: Maybe Void Source #
FromJSON All Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser All Source # parseJSONList :: Value -> Parser [All] Source # omittedField :: Maybe All Source #
FromJSON Any Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Any Source # parseJSONList :: Value -> Parser [Any] Source # omittedField :: Maybe Any Source #
FromJSON Version Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Version Source # parseJSONList :: Value -> Parser [Version] Source # omittedField :: Maybe Version Source #
FromJSON CTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser CTime Source # parseJSONList :: Value -> Parser [CTime] Source # omittedField :: Maybe CTime Source #
FromJSON Int16 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Int16 Source # parseJSONList :: Value -> Parser [Int16] Source # omittedField :: Maybe Int16 Source #
FromJSON Int32 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Int32 Source # parseJSONList :: Value -> Parser [Int32] Source # omittedField :: Maybe Int32 Source #
FromJSON Int64 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Int64 Source # parseJSONList :: Value -> Parser [Int64] Source # omittedField :: Maybe Int64 Source #
FromJSON Int8 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Int8 Source # parseJSONList :: Value -> Parser [Int8] Source # omittedField :: Maybe Int8 Source #
FromJSON Word16 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Word16 Source # parseJSONList :: Value -> Parser [Word16] Source # omittedField :: Maybe Word16 Source #
FromJSON Word32 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Word32 Source # parseJSONList :: Value -> Parser [Word32] Source # omittedField :: Maybe Word32 Source #
FromJSON Word64 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Word64 Source # parseJSONList :: Value -> Parser [Word64] Source # omittedField :: Maybe Word64 Source #
FromJSON Word8 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Word8 Source # parseJSONList :: Value -> Parser [Word8] Source # omittedField :: Maybe Word8 Source #
FromJSON Ordering Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Ordering Source # parseJSONList :: Value -> Parser [Ordering] Source # omittedField :: Maybe Ordering Source #
FromJSON URI Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser URI Source # parseJSONList :: Value -> Parser [URI] Source # omittedField :: Maybe URI Source #
FromJSON Scientific Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Scientific Source # parseJSONList :: Value -> Parser [Scientific] Source # omittedField :: Maybe Scientific Source #
FromJSON Text Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Text Source # parseJSONList :: Value -> Parser [Text] Source # omittedField :: Maybe Text Source #
FromJSON Text Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Text Source # parseJSONList :: Value -> Parser [Text] Source # omittedField :: Maybe Text Source #
FromJSON ShortText Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser ShortText Source # parseJSONList :: Value -> Parser [ShortText] Source # omittedField :: Maybe ShortText Source #
FromJSON CalendarDiffDays Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser CalendarDiffDays Source # parseJSONList :: Value -> Parser [CalendarDiffDays] Source # omittedField :: Maybe CalendarDiffDays Source #
FromJSON Day Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Day Source # parseJSONList :: Value -> Parser [Day] Source # omittedField :: Maybe Day Source #
FromJSON Month Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Month Source # parseJSONList :: Value -> Parser [Month] Source # omittedField :: Maybe Month Source #
FromJSON Quarter Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Quarter Source # parseJSONList :: Value -> Parser [Quarter] Source # omittedField :: Maybe Quarter Source #
FromJSON QuarterOfYear Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser QuarterOfYear Source # parseJSONList :: Value -> Parser [QuarterOfYear] Source # omittedField :: Maybe QuarterOfYear Source #
FromJSON DayOfWeek Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser DayOfWeek Source # parseJSONList :: Value -> Parser [DayOfWeek] Source # omittedField :: Maybe DayOfWeek Source #
FromJSON DiffTime Source # | This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Scientific` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser DiffTime Source # parseJSONList :: Value -> Parser [DiffTime] Source # omittedField :: Maybe DiffTime Source #
FromJSON NominalDiffTime Source # | This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Scientific` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser NominalDiffTime Source # parseJSONList :: Value -> Parser [NominalDiffTime] Source # omittedField :: Maybe NominalDiffTime Source #
FromJSON SystemTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser SystemTime Source # parseJSONList :: Value -> Parser [SystemTime] Source # omittedField :: Maybe SystemTime Source #
FromJSON UTCTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser UTCTime Source # parseJSONList :: Value -> Parser [UTCTime] Source # omittedField :: Maybe UTCTime Source #
FromJSON CalendarDiffTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser CalendarDiffTime Source # parseJSONList :: Value -> Parser [CalendarDiffTime] Source # omittedField :: Maybe CalendarDiffTime Source #
FromJSON LocalTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser LocalTime Source # parseJSONList :: Value -> Parser [LocalTime] Source # omittedField :: Maybe LocalTime Source #
FromJSON TimeOfDay Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser TimeOfDay Source # parseJSONList :: Value -> Parser [TimeOfDay] Source # omittedField :: Maybe TimeOfDay Source #

FromJSON ZonedTime Source #

Supported string formats:

`YYYY-MM-DD HH:MMZ` `YYYY-MM-DD HH:MM:SSZ` `YYYY-MM-DD HH:MM:SS.SSSZ`

The first space may instead be a `T`, and the second space is optional. The `Z` represents UTC. The `Z` may be replaced with a time zone offset of the form `+0000` or `-08:00`, where the first two digits are hours, the `:` is optional and the second two digits (also optional) are minutes.

Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser ZonedTime Source # parseJSONList :: Value -> Parser [ZonedTime] Source # omittedField :: Maybe ZonedTime Source #
FromJSON UUID Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser UUID Source # parseJSONList :: Value -> Parser [UUID] Source # omittedField :: Maybe UUID Source #
FromJSON Integer Source # | This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Scientific` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Integer Source # parseJSONList :: Value -> Parser [Integer] Source # omittedField :: Maybe Integer Source #
FromJSON Natural Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Natural Source # parseJSONList :: Value -> Parser [Natural] Source # omittedField :: Maybe Natural Source #
FromJSON () Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser () Source # parseJSONList :: Value -> Parser [()] Source # omittedField :: Maybe () Source #
FromJSON Bool Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Bool Source # parseJSONList :: Value -> Parser [Bool] Source # omittedField :: Maybe Bool Source #
FromJSON Char Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Char Source # parseJSONList :: Value -> Parser [Char] Source # omittedField :: Maybe Char Source #
FromJSON Double Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Double Source # parseJSONList :: Value -> Parser [Double] Source # omittedField :: Maybe Double Source #
FromJSON Float Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Float Source # parseJSONList :: Value -> Parser [Float] Source # omittedField :: Maybe Float Source #
FromJSON Int Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Int Source # parseJSONList :: Value -> Parser [Int] Source # omittedField :: Maybe Int Source #
FromJSON Word Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Word Source # parseJSONList :: Value -> Parser [Word] Source # omittedField :: Maybe Word Source #
FromJSON v => FromJSON (KeyMap v) Source # | Since: 2.0.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (KeyMap v) Source # parseJSONList :: Value -> Parser [KeyMap v] Source # omittedField :: Maybe (KeyMap v) Source #
FromJSON a => FromJSON (First a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (First a) Source # parseJSONList :: Value -> Parser [First a] Source # omittedField :: Maybe (First a) Source #
FromJSON a => FromJSON (Last a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Last a) Source # parseJSONList :: Value -> Parser [Last a] Source # omittedField :: Maybe (Last a) Source #
FromJSON a => FromJSON (Max a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Max a) Source # parseJSONList :: Value -> Parser [Max a] Source # omittedField :: Maybe (Max a) Source #
FromJSON a => FromJSON (Min a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Min a) Source # parseJSONList :: Value -> Parser [Min a] Source # omittedField :: Maybe (Min a) Source #
FromJSON a => FromJSON (WrappedMonoid a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (WrappedMonoid a) Source # parseJSONList :: Value -> Parser [WrappedMonoid a] Source # omittedField :: Maybe (WrappedMonoid a) Source #
FromJSON a => FromJSON (IntMap a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (IntMap a) Source # parseJSONList :: Value -> Parser [IntMap a] Source # omittedField :: Maybe (IntMap a) Source #
FromJSON a => FromJSON (Seq a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Seq a) Source # parseJSONList :: Value -> Parser [Seq a] Source # omittedField :: Maybe (Seq a) Source #
(Ord a, FromJSON a) => FromJSON (Set a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Set a) Source # parseJSONList :: Value -> Parser [Set a] Source # omittedField :: Maybe (Set a) Source #
FromJSON v => FromJSON (Tree v) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Tree v) Source # parseJSONList :: Value -> Parser [Tree v] Source # omittedField :: Maybe (Tree v) Source #
FromJSON1 f => FromJSON (Fix f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Fix f) Source # parseJSONList :: Value -> Parser [Fix f] Source # omittedField :: Maybe (Fix f) Source #
(FromJSON1 f, Functor f) => FromJSON (Mu f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Mu f) Source # parseJSONList :: Value -> Parser [Mu f] Source # omittedField :: Maybe (Mu f) Source #
(FromJSON1 f, Functor f) => FromJSON (Nu f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Nu f) Source # parseJSONList :: Value -> Parser [Nu f] Source # omittedField :: Maybe (Nu f) Source #
FromJSON a => FromJSON (DNonEmpty a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (DNonEmpty a) Source # parseJSONList :: Value -> Parser [DNonEmpty a] Source # omittedField :: Maybe (DNonEmpty a) Source #
FromJSON a => FromJSON (DList a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (DList a) Source # parseJSONList :: Value -> Parser [DList a] Source # omittedField :: Maybe (DList a) Source #
FromJSON a => FromJSON (NonEmpty a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (NonEmpty a) Source # parseJSONList :: Value -> Parser [NonEmpty a] Source # omittedField :: Maybe (NonEmpty a) Source #
FromJSON a => FromJSON (Identity a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Identity a) Source # parseJSONList :: Value -> Parser [Identity a] Source # omittedField :: Maybe (Identity a) Source #
FromJSON a => FromJSON (First a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (First a) Source # parseJSONList :: Value -> Parser [First a] Source # omittedField :: Maybe (First a) Source #
FromJSON a => FromJSON (Last a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Last a) Source # parseJSONList :: Value -> Parser [Last a] Source # omittedField :: Maybe (Last a) Source #
FromJSON a => FromJSON (Down a) Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Down a) Source # parseJSONList :: Value -> Parser [Down a] Source # omittedField :: Maybe (Down a) Source #
FromJSON a => FromJSON (Dual a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Dual a) Source # parseJSONList :: Value -> Parser [Dual a] Source # omittedField :: Maybe (Dual a) Source #
FromJSON a => FromJSON (Product a) Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Product a) Source # parseJSONList :: Value -> Parser [Product a] Source # omittedField :: Maybe (Product a) Source #
FromJSON a => FromJSON (Sum a) Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Sum a) Source # parseJSONList :: Value -> Parser [Sum a] Source # omittedField :: Maybe (Sum a) Source #
(Generic a, GFromJSON Zero (Rep a)) => FromJSON (Generically a) Source # | Since: 2.1.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Generically a) Source # parseJSONList :: Value -> Parser [Generically a] Source # omittedField :: Maybe (Generically a) Source #
(FromJSON a, Integral a) => FromJSON (Ratio a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Ratio a) Source # parseJSONList :: Value -> Parser [Ratio a] Source # omittedField :: Maybe (Ratio a) Source #
FromJSON a => FromJSON (Array a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Array a) Source # parseJSONList :: Value -> Parser [Array a] Source # omittedField :: Maybe (Array a) Source #
(Prim a, FromJSON a) => FromJSON (PrimArray a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (PrimArray a) Source # parseJSONList :: Value -> Parser [PrimArray a] Source # omittedField :: Maybe (PrimArray a) Source #
FromJSON a => FromJSON (SmallArray a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (SmallArray a) Source # parseJSONList :: Value -> Parser [SmallArray a] Source # omittedField :: Maybe (SmallArray a) Source #
FromJSON a => FromJSON (Maybe a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Maybe a) Source # parseJSONList :: Value -> Parser [Maybe a] Source # omittedField :: Maybe (Maybe a) Source #
(Eq a, Hashable a, FromJSON a) => FromJSON (HashSet a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (HashSet a) Source # parseJSONList :: Value -> Parser [HashSet a] Source # omittedField :: Maybe (HashSet a) Source #
FromJSON a => FromJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Vector a) Source # parseJSONList :: Value -> Parser [Vector a] Source # omittedField :: Maybe (Vector a) Source #
(Prim a, FromJSON a) => FromJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Vector a) Source # parseJSONList :: Value -> Parser [Vector a] Source # omittedField :: Maybe (Vector a) Source #
(Storable a, FromJSON a) => FromJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Vector a) Source # parseJSONList :: Value -> Parser [Vector a] Source # omittedField :: Maybe (Vector a) Source #
(Vector Vector a, FromJSON a) => FromJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Vector a) Source # parseJSONList :: Value -> Parser [Vector a] Source # omittedField :: Maybe (Vector a) Source #
FromJSON a => FromJSON (Maybe a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Maybe a) Source # parseJSONList :: Value -> Parser [Maybe a] Source # omittedField :: Maybe (Maybe a) Source #
FromJSON a => FromJSON (Solo a) Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Solo a) Source # parseJSONList :: Value -> Parser [Solo a] Source # omittedField :: Maybe (Solo a) Source #
FromJSON a => FromJSON [a] Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser [a] Source # parseJSONList :: Value -> Parser [[a]] Source # omittedField :: Maybe [a] Source #
HasResolution a => FromJSON (Fixed a) Source # | This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Scientific` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Fixed a) Source # parseJSONList :: Value -> Parser [Fixed a] Source # omittedField :: Maybe (Fixed a) Source #
(FromJSONKey k, Ord k, FromJSON v) => FromJSON (Map k v) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Map k v) Source # parseJSONList :: Value -> Parser [Map k v] Source # omittedField :: Maybe (Map k v) Source #
(FromJSON a, FromJSON b) => FromJSON (Either a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Either a b) Source # parseJSONList :: Value -> Parser [Either a b] Source # omittedField :: Maybe (Either a b) Source #
FromJSON (Proxy a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Proxy a) Source # parseJSONList :: Value -> Parser [Proxy a] Source # omittedField :: Maybe (Proxy a) Source #
(FromJSON a, FromJSON b) => FromJSON (Either a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Either a b) Source # parseJSONList :: Value -> Parser [Either a b] Source # omittedField :: Maybe (Either a b) Source #
(FromJSON a, FromJSON b) => FromJSON (These a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (These a b) Source # parseJSONList :: Value -> Parser [These a b] Source # omittedField :: Maybe (These a b) Source #
(FromJSON a, FromJSON b) => FromJSON (Pair a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Pair a b) Source # parseJSONList :: Value -> Parser [Pair a b] Source # omittedField :: Maybe (Pair a b) Source #
(FromJSON a, FromJSON b) => FromJSON (These a b) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (These a b) Source # parseJSONList :: Value -> Parser [These a b] Source # omittedField :: Maybe (These a b) Source #
(FromJSON v, FromJSONKey k, Eq k, Hashable k) => FromJSON (HashMap k v) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (HashMap k v) Source # parseJSONList :: Value -> Parser [HashMap k v] Source # omittedField :: Maybe (HashMap k v) Source #
(FromJSON a, FromJSON b) => FromJSON (a, b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b) Source # parseJSONList :: Value -> Parser [(a, b)] Source # omittedField :: Maybe (a, b) Source #
FromJSON a => FromJSON (Const a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Const a b) Source # parseJSONList :: Value -> Parser [Const a b] Source # omittedField :: Maybe (Const a b) Source #
FromJSON b => FromJSON (Tagged a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Tagged a b) Source # parseJSONList :: Value -> Parser [Tagged a b] Source # omittedField :: Maybe (Tagged a b) Source #
(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (These1 f g a) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (These1 f g a) Source # parseJSONList :: Value -> Parser [These1 f g a] Source # omittedField :: Maybe (These1 f g a) Source #
(FromJSON a, FromJSON b, FromJSON c) => FromJSON (a, b, c) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c) Source # parseJSONList :: Value -> Parser [(a, b, c)] Source # omittedField :: Maybe (a, b, c) Source #
(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Product f g a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Product f g a) Source # parseJSONList :: Value -> Parser [Product f g a] Source # omittedField :: Maybe (Product f g a) Source #
(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Sum f g a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Sum f g a) Source # parseJSONList :: Value -> Parser [Sum f g a] Source # omittedField :: Maybe (Sum f g a) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSON (a, b, c, d) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d) Source # parseJSONList :: Value -> Parser [(a, b, c, d)] Source # omittedField :: Maybe (a, b, c, d) Source #
(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Compose f g a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (Compose f g a) Source # parseJSONList :: Value -> Parser [Compose f g a] Source # omittedField :: Maybe (Compose f g a) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e) => FromJSON (a, b, c, d, e) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e)] Source # omittedField :: Maybe (a, b, c, d, e) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f) => FromJSON (a, b, c, d, e, f) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f)] Source # omittedField :: Maybe (a, b, c, d, e, f) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g) => FromJSON (a, b, c, d, e, f, g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g)] Source # omittedField :: Maybe (a, b, c, d, e, f, g) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h) => FromJSON (a, b, c, d, e, f, g, h) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i) => FromJSON (a, b, c, d, e, f, g, h, i) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j) => FromJSON (a, b, c, d, e, f, g, h, i, j) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k) => FromJSON (a, b, c, d, e, f, g, h, i, j, k) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j, k) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l) => FromJSON (a, b, c, d, e, f, g, h, i, j, k, l) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j, k, l) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m) => FromJSON (a, b, c, d, e, f, g, h, i, j, k, l, m) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m, FromJSON n) => FromJSON (a, b, c, d, e, f, g, h, i, j, k, l, m, n) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m, n) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m, n)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m, n) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m, FromJSON n, FromJSON o) => FromJSON (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) Source # parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)] Source # omittedField :: Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) Source #

data Result a Source #

The result of running a `Parser`.

Constructors

Error String |
Success a |

#### Instances

Instances details

Alternative Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods empty :: Result a Source # (<|>) :: Result a -> Result a -> Result a Source # some :: Result a -> Result [a] Source # many :: Result a -> Result [a] Source #
Applicative Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods pure :: a -> Result a Source # (<*>) :: Result (a -> b) -> Result a -> Result b Source # liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c Source # (*>) :: Result a -> Result b -> Result b Source # (<*) :: Result a -> Result b -> Result a Source #
Functor Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods fmap :: (a -> b) -> Result a -> Result b Source # (<$) :: a -> Result b -> Result a Source #
Monad Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (>>=) :: Result a -> (a -> Result b) -> Result b Source # (>>) :: Result a -> Result b -> Result b Source # return :: a -> Result a Source #
MonadPlus Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods mzero :: Result a Source # mplus :: Result a -> Result a -> Result a Source #
MonadFail Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods fail :: String -> Result a Source #
Foldable Result Source # |

Instance details

Defined in Data.Aeson.Types.Internal

Methods

fold :: Monoid m => Result m -> m Source #

foldMap :: Monoid m => (a -> m) -> Result a -> m Source #

foldMap' :: Monoid m => (a -> m) -> Result a -> m Source #

foldr :: (a -> b -> b) -> b -> Result a -> b Source #

foldr' :: (a -> b -> b) -> b -> Result a -> b Source #

foldl :: (b -> a -> b) -> b -> Result a -> b Source #

foldl' :: (b -> a -> b) -> b -> Result a -> b Source #

foldr1 :: (a -> a -> a) -> Result a -> a Source #

foldl1 :: (a -> a -> a) -> Result a -> a Source #

toList :: Result a -> [a] Source #

null :: Result a -> Bool Source #

length :: Result a -> Int Source #

elem :: Eq a => a -> Result a -> Bool Source #

maximum :: Ord a => Result a -> a Source #

minimum :: Ord a => Result a -> a Source #

sum :: Num a => Result a -> a Source #

product :: Num a => Result a -> a Source #

Traversable Result Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods traverse :: Applicative f => (a -> f b) -> Result a -> f (Result b) Source # sequenceA :: Applicative f => Result (f a) -> f (Result a) Source # mapM :: Monad m => (a -> m b) -> Result a -> m (Result b) Source # sequence :: Monad m => Result (m a) -> m (Result a) Source #
NFData a => NFData (Result a) Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods rnf :: Result a -> () Source #
Monoid (Result a) Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods mempty :: Result a Source # mappend :: Result a -> Result a -> Result a Source # mconcat :: [Result a] -> Result a Source #
Semigroup (Result a) Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (<>) :: Result a -> Result a -> Result a Source # sconcat :: NonEmpty (Result a) -> Result a Source # stimes :: Integral b => b -> Result a -> Result a Source #
Show a => Show (Result a) Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> Result a -> ShowS Source # show :: Result a -> String Source # showList :: [Result a] -> ShowS Source #
Eq a => Eq (Result a) Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (==) :: Result a -> Result a -> Bool Source # (/=) :: Result a -> Result a -> Bool Source #

fromJSON :: FromJSON a => Value -> Result a Source #

Convert a value from JSON, failing if the types do not match.

class ToJSON a where Source #

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 write Text literals.
    {-# LANGUAGE OverloadedStrings #-}

    data Coord = Coord { x :: Double, y :: Double }

    instance ToJSON Coord where
      toJSON (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 `Generic`` clause to your datatype and declare a `ToJSON` 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 via Generically Coord instance ToJSON Coord

If on the other hand you wish to customize the generic decoding, you have to implement both methods:

    customOptions = defaultOptions
                    { fieldLabelModifier = map toUpper
                    }

    instance ToJSON Coord where
        toJSON     = genericToJSON customOptions
        toEncoding = genericToEncoding customOptions

Previous versions of this library only had the `toJSON` method. Adding `toEncoding` had two reasons:

1. `toEncoding` is more efficient for the common case that the output of `toJSON` is directly serialized to a `ByteString`. Further, expressing either method in terms of the other would be non-optimal.
2. The choice of defaults allows a smooth transition for existing users: Existing instances that do not define `toEncoding` still compile and have the correct semantics. This is ensured by making the default implementation of `toEncoding` use `toJSON`. This produces correct results, but since it performs an intermediate conversion to a `Value`, it will be less efficient than directly emitting an `Encoding`. (this also means that specifying nothing more than `instance ToJSON Coord` would be sufficient as a generically decoding instance, but there probably exists no good reason to not specify `toEncoding` in new instances.)

Minimal complete definition

Nothing

Methods

toJSON :: a -> Value Source #

Convert a Haskell value to a JSON-friendly intermediate type.

default toJSON :: (Generic a, GToJSON' Value Zero (Rep a)) => a -> Value Source #

toEncoding :: a -> Encoding Source #

Encode a Haskell value as JSON.

The default implementation of this method creates an intermediate `Value` using `toJSON`. This provides source-level compatibility for people upgrading from older versions of this library, but obviously offers no performance advantage.

To benefit from direct encoding, you must provide an implementation for this method. The easiest way to do so is by having your types implement `Generic` using the `DeriveGeneric` extension, and then have GHC generate a method body as follows.

    instance ToJSON Coord where
        toEncoding = genericToEncoding defaultOptions

toJSONList :: [a] -> Value Source #

toEncodingList :: [a] -> Encoding Source #

omitField :: a -> Bool Source #

Defines when it is acceptable to omit a field of this type from a record. Used by `(`.?=`)` operator, and Generics and TH deriving with ``omitNothingFields` = True`.

Since: 2.2.0.0

#### Instances

Instances details

ToJSON Key Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Key -> Value Source # toEncoding :: Key -> Encoding Source # toJSONList :: [Key] -> Value Source # toEncodingList :: [Key] -> Encoding Source # omitField :: Key -> Bool Source #
ToJSON DotNetTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DotNetTime -> Value Source # toEncoding :: DotNetTime -> Encoding Source # toJSONList :: [DotNetTime] -> Value Source # toEncodingList :: [DotNetTime] -> Encoding Source # omitField :: DotNetTime -> Bool Source #
ToJSON Value Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Value -> Value Source # toEncoding :: Value -> Encoding Source # toJSONList :: [Value] -> Value Source # toEncodingList :: [Value] -> Encoding Source # omitField :: Value -> Bool Source #
ToJSON IntSet Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: IntSet -> Value Source # toEncoding :: IntSet -> Encoding Source # toJSONList :: [IntSet] -> Value Source # toEncodingList :: [IntSet] -> Encoding Source # omitField :: IntSet -> Bool Source #
ToJSON Void Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Void -> Value Source # toEncoding :: Void -> Encoding Source # toJSONList :: [Void] -> Value Source # toEncodingList :: [Void] -> Encoding Source # omitField :: Void -> Bool Source #
ToJSON All Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: All -> Value Source # toEncoding :: All -> Encoding Source # toJSONList :: [All] -> Value Source # toEncodingList :: [All] -> Encoding Source # omitField :: All -> Bool Source #
ToJSON Any Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Any -> Value Source # toEncoding :: Any -> Encoding Source # toJSONList :: [Any] -> Value Source # toEncodingList :: [Any] -> Encoding Source # omitField :: Any -> Bool Source #
ToJSON Version Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Version -> Value Source # toEncoding :: Version -> Encoding Source # toJSONList :: [Version] -> Value Source # toEncodingList :: [Version] -> Encoding Source # omitField :: Version -> Bool Source #
ToJSON CTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: CTime -> Value Source # toEncoding :: CTime -> Encoding Source # toJSONList :: [CTime] -> Value Source # toEncodingList :: [CTime] -> Encoding Source # omitField :: CTime -> Bool Source #
ToJSON Int16 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Int16 -> Value Source # toEncoding :: Int16 -> Encoding Source # toJSONList :: [Int16] -> Value Source # toEncodingList :: [Int16] -> Encoding Source # omitField :: Int16 -> Bool Source #
ToJSON Int32 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Int32 -> Value Source # toEncoding :: Int32 -> Encoding Source # toJSONList :: [Int32] -> Value Source # toEncodingList :: [Int32] -> Encoding Source # omitField :: Int32 -> Bool Source #
ToJSON Int64 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Int64 -> Value Source # toEncoding :: Int64 -> Encoding Source # toJSONList :: [Int64] -> Value Source # toEncodingList :: [Int64] -> Encoding Source # omitField :: Int64 -> Bool Source #
ToJSON Int8 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Int8 -> Value Source # toEncoding :: Int8 -> Encoding Source # toJSONList :: [Int8] -> Value Source # toEncodingList :: [Int8] -> Encoding Source # omitField :: Int8 -> Bool Source #
ToJSON Word16 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Word16 -> Value Source # toEncoding :: Word16 -> Encoding Source # toJSONList :: [Word16] -> Value Source # toEncodingList :: [Word16] -> Encoding Source # omitField :: Word16 -> Bool Source #
ToJSON Word32 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Word32 -> Value Source # toEncoding :: Word32 -> Encoding Source # toJSONList :: [Word32] -> Value Source # toEncodingList :: [Word32] -> Encoding Source # omitField :: Word32 -> Bool Source #
ToJSON Word64 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Word64 -> Value Source # toEncoding :: Word64 -> Encoding Source # toJSONList :: [Word64] -> Value Source # toEncodingList :: [Word64] -> Encoding Source # omitField :: Word64 -> Bool Source #
ToJSON Word8 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Word8 -> Value Source # toEncoding :: Word8 -> Encoding Source # toJSONList :: [Word8] -> Value Source # toEncodingList :: [Word8] -> Encoding Source # omitField :: Word8 -> Bool Source #
ToJSON Ordering Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Ordering -> Value Source # toEncoding :: Ordering -> Encoding Source # toJSONList :: [Ordering] -> Value Source # toEncodingList :: [Ordering] -> Encoding Source # omitField :: Ordering -> Bool Source #
ToJSON URI Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: URI -> Value Source # toEncoding :: URI -> Encoding Source # toJSONList :: [URI] -> Value Source # toEncodingList :: [URI] -> Encoding Source # omitField :: URI -> Bool Source #
ToJSON Scientific Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Scientific -> Value Source # toEncoding :: Scientific -> Encoding Source # toJSONList :: [Scientific] -> Value Source # toEncodingList :: [Scientific] -> Encoding Source # omitField :: Scientific -> Bool Source #
ToJSON Text Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Text -> Value Source # toEncoding :: Text -> Encoding Source # toJSONList :: [Text] -> Value Source # toEncodingList :: [Text] -> Encoding Source # omitField :: Text -> Bool Source #
ToJSON Text Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Text -> Value Source # toEncoding :: Text -> Encoding Source # toJSONList :: [Text] -> Value Source # toEncodingList :: [Text] -> Encoding Source # omitField :: Text -> Bool Source #
ToJSON ShortText Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: ShortText -> Value Source # toEncoding :: ShortText -> Encoding Source # toJSONList :: [ShortText] -> Value Source # toEncodingList :: [ShortText] -> Encoding Source # omitField :: ShortText -> Bool Source #
ToJSON CalendarDiffDays Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: CalendarDiffDays -> Value Source # toEncoding :: CalendarDiffDays -> Encoding Source # toJSONList :: [CalendarDiffDays] -> Value Source # toEncodingList :: [CalendarDiffDays] -> Encoding Source # omitField :: CalendarDiffDays -> Bool Source #
ToJSON Day Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Day -> Value Source # toEncoding :: Day -> Encoding Source # toJSONList :: [Day] -> Value Source # toEncodingList :: [Day] -> Encoding Source # omitField :: Day -> Bool Source #
ToJSON Month Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Month -> Value Source # toEncoding :: Month -> Encoding Source # toJSONList :: [Month] -> Value Source # toEncodingList :: [Month] -> Encoding Source # omitField :: Month -> Bool Source #
ToJSON Quarter Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Quarter -> Value Source # toEncoding :: Quarter -> Encoding Source # toJSONList :: [Quarter] -> Value Source # toEncodingList :: [Quarter] -> Encoding Source # omitField :: Quarter -> Bool Source #
ToJSON QuarterOfYear Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: QuarterOfYear -> Value Source # toEncoding :: QuarterOfYear -> Encoding Source # toJSONList :: [QuarterOfYear] -> Value Source # toEncodingList :: [QuarterOfYear] -> Encoding Source # omitField :: QuarterOfYear -> Bool Source #
ToJSON DayOfWeek Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DayOfWeek -> Value Source # toEncoding :: DayOfWeek -> Encoding Source # toJSONList :: [DayOfWeek] -> Value Source # toEncodingList :: [DayOfWeek] -> Encoding Source # omitField :: DayOfWeek -> Bool Source #
ToJSON DiffTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DiffTime -> Value Source # toEncoding :: DiffTime -> Encoding Source # toJSONList :: [DiffTime] -> Value Source # toEncodingList :: [DiffTime] -> Encoding Source # omitField :: DiffTime -> Bool Source #
ToJSON NominalDiffTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: NominalDiffTime -> Value Source # toEncoding :: NominalDiffTime -> Encoding Source # toJSONList :: [NominalDiffTime] -> Value Source # toEncodingList :: [NominalDiffTime] -> Encoding Source # omitField :: NominalDiffTime -> Bool Source #
ToJSON SystemTime Source # | Encoded as number
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: SystemTime -> Value Source # toEncoding :: SystemTime -> Encoding Source # toJSONList :: [SystemTime] -> Value Source # toEncodingList :: [SystemTime] -> Encoding Source # omitField :: SystemTime -> Bool Source #
ToJSON UTCTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: UTCTime -> Value Source # toEncoding :: UTCTime -> Encoding Source # toJSONList :: [UTCTime] -> Value Source # toEncodingList :: [UTCTime] -> Encoding Source # omitField :: UTCTime -> Bool Source #
ToJSON CalendarDiffTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: CalendarDiffTime -> Value Source # toEncoding :: CalendarDiffTime -> Encoding Source # toJSONList :: [CalendarDiffTime] -> Value Source # toEncodingList :: [CalendarDiffTime] -> Encoding Source # omitField :: CalendarDiffTime -> Bool Source #
ToJSON LocalTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: LocalTime -> Value Source # toEncoding :: LocalTime -> Encoding Source # toJSONList :: [LocalTime] -> Value Source # toEncodingList :: [LocalTime] -> Encoding Source # omitField :: LocalTime -> Bool Source #
ToJSON TimeOfDay Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: TimeOfDay -> Value Source # toEncoding :: TimeOfDay -> Encoding Source # toJSONList :: [TimeOfDay] -> Value Source # toEncodingList :: [TimeOfDay] -> Encoding Source # omitField :: TimeOfDay -> Bool Source #
ToJSON ZonedTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: ZonedTime -> Value Source # toEncoding :: ZonedTime -> Encoding Source # toJSONList :: [ZonedTime] -> Value Source # toEncodingList :: [ZonedTime] -> Encoding Source # omitField :: ZonedTime -> Bool Source #
ToJSON UUID Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: UUID -> Value Source # toEncoding :: UUID -> Encoding Source # toJSONList :: [UUID] -> Value Source # toEncodingList :: [UUID] -> Encoding Source # omitField :: UUID -> Bool Source #
ToJSON Integer Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Integer -> Value Source # toEncoding :: Integer -> Encoding Source # toJSONList :: [Integer] -> Value Source # toEncodingList :: [Integer] -> Encoding Source # omitField :: Integer -> Bool Source #
ToJSON Natural Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Natural -> Value Source # toEncoding :: Natural -> Encoding Source # toJSONList :: [Natural] -> Value Source # toEncodingList :: [Natural] -> Encoding Source # omitField :: Natural -> Bool Source #
ToJSON () Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: () -> Value Source # toEncoding :: () -> Encoding Source # toJSONList :: [()] -> Value Source # toEncodingList :: [()] -> Encoding Source # omitField :: () -> Bool Source #
ToJSON Bool Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Bool -> Value Source # toEncoding :: Bool -> Encoding Source # toJSONList :: [Bool] -> Value Source # toEncodingList :: [Bool] -> Encoding Source # omitField :: Bool -> Bool Source #
ToJSON Char Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Char -> Value Source # toEncoding :: Char -> Encoding Source # toJSONList :: [Char] -> Value Source # toEncodingList :: [Char] -> Encoding Source # omitField :: Char -> Bool Source #
ToJSON Double Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Double -> Value Source # toEncoding :: Double -> Encoding Source # toJSONList :: [Double] -> Value Source # toEncodingList :: [Double] -> Encoding Source # omitField :: Double -> Bool Source #
ToJSON Float Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Float -> Value Source # toEncoding :: Float -> Encoding Source # toJSONList :: [Float] -> Value Source # toEncodingList :: [Float] -> Encoding Source # omitField :: Float -> Bool Source #
ToJSON Int Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Int -> Value Source # toEncoding :: Int -> Encoding Source # toJSONList :: [Int] -> Value Source # toEncodingList :: [Int] -> Encoding Source # omitField :: Int -> Bool Source #
ToJSON Word Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Word -> Value Source # toEncoding :: Word -> Encoding Source # toJSONList :: [Word] -> Value Source # toEncodingList :: [Word] -> Encoding Source # omitField :: Word -> Bool Source #
ToJSON v => ToJSON (KeyMap v) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: KeyMap v -> Value Source # toEncoding :: KeyMap v -> Encoding Source # toJSONList :: [KeyMap v] -> Value Source # toEncodingList :: [KeyMap v] -> Encoding Source # omitField :: KeyMap v -> Bool Source #
ToJSON a => ToJSON (First a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: First a -> Value Source # toEncoding :: First a -> Encoding Source # toJSONList :: [First a] -> Value Source # toEncodingList :: [First a] -> Encoding Source # omitField :: First a -> Bool Source #
ToJSON a => ToJSON (Last a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Last a -> Value Source # toEncoding :: Last a -> Encoding Source # toJSONList :: [Last a] -> Value Source # toEncodingList :: [Last a] -> Encoding Source # omitField :: Last a -> Bool Source #
ToJSON a => ToJSON (Max a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Max a -> Value Source # toEncoding :: Max a -> Encoding Source # toJSONList :: [Max a] -> Value Source # toEncodingList :: [Max a] -> Encoding Source # omitField :: Max a -> Bool Source #
ToJSON a => ToJSON (Min a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Min a -> Value Source # toEncoding :: Min a -> Encoding Source # toJSONList :: [Min a] -> Value Source # toEncodingList :: [Min a] -> Encoding Source # omitField :: Min a -> Bool Source #
ToJSON a => ToJSON (WrappedMonoid a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: WrappedMonoid a -> Value Source # toEncoding :: WrappedMonoid a -> Encoding Source # toJSONList :: [WrappedMonoid a] -> Value Source # toEncodingList :: [WrappedMonoid a] -> Encoding Source # omitField :: WrappedMonoid a -> Bool Source #
ToJSON a => ToJSON (IntMap a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: IntMap a -> Value Source # toEncoding :: IntMap a -> Encoding Source # toJSONList :: [IntMap a] -> Value Source # toEncodingList :: [IntMap a] -> Encoding Source # omitField :: IntMap a -> Bool Source #
ToJSON a => ToJSON (Seq a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Seq a -> Value Source # toEncoding :: Seq a -> Encoding Source # toJSONList :: [Seq a] -> Value Source # toEncodingList :: [Seq a] -> Encoding Source # omitField :: Seq a -> Bool Source #
ToJSON a => ToJSON (Set a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Set a -> Value Source # toEncoding :: Set a -> Encoding Source # toJSONList :: [Set a] -> Value Source # toEncodingList :: [Set a] -> Encoding Source # omitField :: Set a -> Bool Source #
ToJSON v => ToJSON (Tree v) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Tree v -> Value Source # toEncoding :: Tree v -> Encoding Source # toJSONList :: [Tree v] -> Value Source # toEncodingList :: [Tree v] -> Encoding Source # omitField :: Tree v -> Bool Source #
ToJSON1 f => ToJSON (Fix f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Fix f -> Value Source # toEncoding :: Fix f -> Encoding Source # toJSONList :: [Fix f] -> Value Source # toEncodingList :: [Fix f] -> Encoding Source # omitField :: Fix f -> Bool Source #
(ToJSON1 f, Functor f) => ToJSON (Mu f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Mu f -> Value Source # toEncoding :: Mu f -> Encoding Source # toJSONList :: [Mu f] -> Value Source # toEncodingList :: [Mu f] -> Encoding Source # omitField :: Mu f -> Bool Source #
(ToJSON1 f, Functor f) => ToJSON (Nu f) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Nu f -> Value Source # toEncoding :: Nu f -> Encoding Source # toJSONList :: [Nu f] -> Value Source # toEncodingList :: [Nu f] -> Encoding Source # omitField :: Nu f -> Bool Source #
ToJSON a => ToJSON (DNonEmpty a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DNonEmpty a -> Value Source # toEncoding :: DNonEmpty a -> Encoding Source # toJSONList :: [DNonEmpty a] -> Value Source # toEncodingList :: [DNonEmpty a] -> Encoding Source # omitField :: DNonEmpty a -> Bool Source #
ToJSON a => ToJSON (DList a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: DList a -> Value Source # toEncoding :: DList a -> Encoding Source # toJSONList :: [DList a] -> Value Source # toEncodingList :: [DList a] -> Encoding Source # omitField :: DList a -> Bool Source #
ToJSON a => ToJSON (NonEmpty a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: NonEmpty a -> Value Source # toEncoding :: NonEmpty a -> Encoding Source # toJSONList :: [NonEmpty a] -> Value Source # toEncodingList :: [NonEmpty a] -> Encoding Source # omitField :: NonEmpty a -> Bool Source #
ToJSON a => ToJSON (Identity a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Identity a -> Value Source # toEncoding :: Identity a -> Encoding Source # toJSONList :: [Identity a] -> Value Source # toEncodingList :: [Identity a] -> Encoding Source # omitField :: Identity a -> Bool Source #
ToJSON a => ToJSON (First a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: First a -> Value Source # toEncoding :: First a -> Encoding Source # toJSONList :: [First a] -> Value Source # toEncodingList :: [First a] -> Encoding Source # omitField :: First a -> Bool Source #
ToJSON a => ToJSON (Last a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Last a -> Value Source # toEncoding :: Last a -> Encoding Source # toJSONList :: [Last a] -> Value Source # toEncodingList :: [Last a] -> Encoding Source # omitField :: Last a -> Bool Source #
ToJSON a => ToJSON (Down a) Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Down a -> Value Source # toEncoding :: Down a -> Encoding Source # toJSONList :: [Down a] -> Value Source # toEncodingList :: [Down a] -> Encoding Source # omitField :: Down a -> Bool Source #
ToJSON a => ToJSON (Dual a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Dual a -> Value Source # toEncoding :: Dual a -> Encoding Source # toJSONList :: [Dual a] -> Value Source # toEncodingList :: [Dual a] -> Encoding Source # omitField :: Dual a -> Bool Source #
ToJSON a => ToJSON (Product a) Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Product a -> Value Source # toEncoding :: Product a -> Encoding Source # toJSONList :: [Product a] -> Value Source # toEncodingList :: [Product a] -> Encoding Source # omitField :: Product a -> Bool Source #
ToJSON a => ToJSON (Sum a) Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Sum a -> Value Source # toEncoding :: Sum a -> Encoding Source # toJSONList :: [Sum a] -> Value Source # toEncodingList :: [Sum a] -> Encoding Source # omitField :: Sum a -> Bool Source #
(Generic a, GToJSON' Value Zero (Rep a), GToJSON' Encoding Zero (Rep a)) => ToJSON (Generically a) Source # | Since: 2.1.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Generically a -> Value Source # toEncoding :: Generically a -> Encoding Source # toJSONList :: [Generically a] -> Value Source # toEncodingList :: [Generically a] -> Encoding Source # omitField :: Generically a -> Bool Source #
(ToJSON a, Integral a) => ToJSON (Ratio a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Ratio a -> Value Source # toEncoding :: Ratio a -> Encoding Source # toJSONList :: [Ratio a] -> Value Source # toEncodingList :: [Ratio a] -> Encoding Source # omitField :: Ratio a -> Bool Source #
ToJSON a => ToJSON (Array a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Array a -> Value Source # toEncoding :: Array a -> Encoding Source # toJSONList :: [Array a] -> Value Source # toEncodingList :: [Array a] -> Encoding Source # omitField :: Array a -> Bool Source #
(Prim a, ToJSON a) => ToJSON (PrimArray a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: PrimArray a -> Value Source # toEncoding :: PrimArray a -> Encoding Source # toJSONList :: [PrimArray a] -> Value Source # toEncodingList :: [PrimArray a] -> Encoding Source # omitField :: PrimArray a -> Bool Source #
ToJSON a => ToJSON (SmallArray a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: SmallArray a -> Value Source # toEncoding :: SmallArray a -> Encoding Source # toJSONList :: [SmallArray a] -> Value Source # toEncodingList :: [SmallArray a] -> Encoding Source # omitField :: SmallArray a -> Bool Source #
ToJSON a => ToJSON (Maybe a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Maybe a -> Value Source # toEncoding :: Maybe a -> Encoding Source # toJSONList :: [Maybe a] -> Value Source # toEncodingList :: [Maybe a] -> Encoding Source # omitField :: Maybe a -> Bool Source #
ToJSON a => ToJSON (HashSet a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: HashSet a -> Value Source # toEncoding :: HashSet a -> Encoding Source # toJSONList :: [HashSet a] -> Value Source # toEncodingList :: [HashSet a] -> Encoding Source # omitField :: HashSet a -> Bool Source #
ToJSON a => ToJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Vector a -> Value Source # toEncoding :: Vector a -> Encoding Source # toJSONList :: [Vector a] -> Value Source # toEncodingList :: [Vector a] -> Encoding Source # omitField :: Vector a -> Bool Source #
(Prim a, ToJSON a) => ToJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Vector a -> Value Source # toEncoding :: Vector a -> Encoding Source # toJSONList :: [Vector a] -> Value Source # toEncodingList :: [Vector a] -> Encoding Source # omitField :: Vector a -> Bool Source #
(Storable a, ToJSON a) => ToJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Vector a -> Value Source # toEncoding :: Vector a -> Encoding Source # toJSONList :: [Vector a] -> Value Source # toEncodingList :: [Vector a] -> Encoding Source # omitField :: Vector a -> Bool Source #
(Vector Vector a, ToJSON a) => ToJSON (Vector a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Vector a -> Value Source # toEncoding :: Vector a -> Encoding Source # toJSONList :: [Vector a] -> Value Source # toEncodingList :: [Vector a] -> Encoding Source # omitField :: Vector a -> Bool Source #
ToJSON a => ToJSON (Maybe a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Maybe a -> Value Source # toEncoding :: Maybe a -> Encoding Source # toJSONList :: [Maybe a] -> Value Source # toEncodingList :: [Maybe a] -> Encoding Source # omitField :: Maybe a -> Bool Source #
ToJSON a => ToJSON (Solo a) Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Solo a -> Value Source # toEncoding :: Solo a -> Encoding Source # toJSONList :: [Solo a] -> Value Source # toEncodingList :: [Solo a] -> Encoding Source # omitField :: Solo a -> Bool Source #
ToJSON a => ToJSON [a] Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: [a] -> Value Source # toEncoding :: [a] -> Encoding Source # toJSONList :: [[a]] -> Value Source # toEncodingList :: [[a]] -> Encoding Source # omitField :: [a] -> Bool Source #
HasResolution a => ToJSON (Fixed a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Fixed a -> Value Source # toEncoding :: Fixed a -> Encoding Source # toJSONList :: [Fixed a] -> Value Source # toEncodingList :: [Fixed a] -> Encoding Source # omitField :: Fixed a -> Bool Source #
(ToJSON v, ToJSONKey k) => ToJSON (Map k v) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Map k v -> Value Source # toEncoding :: Map k v -> Encoding Source # toJSONList :: [Map k v] -> Value Source # toEncodingList :: [Map k v] -> Encoding Source # omitField :: Map k v -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (Either a b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Either a b -> Value Source # toEncoding :: Either a b -> Encoding Source # toJSONList :: [Either a b] -> Value Source # toEncodingList :: [Either a b] -> Encoding Source # omitField :: Either a b -> Bool Source #
ToJSON (Proxy a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Proxy a -> Value Source # toEncoding :: Proxy a -> Encoding Source # toJSONList :: [Proxy a] -> Value Source # toEncodingList :: [Proxy a] -> Encoding Source # omitField :: Proxy a -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (Either a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Either a b -> Value Source # toEncoding :: Either a b -> Encoding Source # toJSONList :: [Either a b] -> Value Source # toEncodingList :: [Either a b] -> Encoding Source # omitField :: Either a b -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (These a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: These a b -> Value Source # toEncoding :: These a b -> Encoding Source # toJSONList :: [These a b] -> Value Source # toEncodingList :: [These a b] -> Encoding Source # omitField :: These a b -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (Pair a b) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Pair a b -> Value Source # toEncoding :: Pair a b -> Encoding Source # toJSONList :: [Pair a b] -> Value Source # toEncodingList :: [Pair a b] -> Encoding Source # omitField :: Pair a b -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (These a b) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: These a b -> Value Source # toEncoding :: These a b -> Encoding Source # toJSONList :: [These a b] -> Value Source # toEncodingList :: [These a b] -> Encoding Source # omitField :: These a b -> Bool Source #
(ToJSON v, ToJSONKey k) => ToJSON (HashMap k v) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: HashMap k v -> Value Source # toEncoding :: HashMap k v -> Encoding Source # toJSONList :: [HashMap k v] -> Value Source # toEncodingList :: [HashMap k v] -> Encoding Source # omitField :: HashMap k v -> Bool Source #
(ToJSON a, ToJSON b) => ToJSON (a, b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b) -> Value Source # toEncoding :: (a, b) -> Encoding Source # toJSONList :: [(a, b)] -> Value Source # toEncodingList :: [(a, b)] -> Encoding Source # omitField :: (a, b) -> Bool Source #
ToJSON a => ToJSON (Const a b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Const a b -> Value Source # toEncoding :: Const a b -> Encoding Source # toJSONList :: [Const a b] -> Value Source # toEncodingList :: [Const a b] -> Encoding Source # omitField :: Const a b -> Bool Source #
ToJSON b => ToJSON (Tagged a b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Tagged a b -> Value Source # toEncoding :: Tagged a b -> Encoding Source # toJSONList :: [Tagged a b] -> Value Source # toEncodingList :: [Tagged a b] -> Encoding Source # omitField :: Tagged a b -> Bool Source #
(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (These1 f g a) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: These1 f g a -> Value Source # toEncoding :: These1 f g a -> Encoding Source # toJSONList :: [These1 f g a] -> Value Source # toEncodingList :: [These1 f g a] -> Encoding Source # omitField :: These1 f g a -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c) => ToJSON (a, b, c) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c) -> Value Source # toEncoding :: (a, b, c) -> Encoding Source # toJSONList :: [(a, b, c)] -> Value Source # toEncodingList :: [(a, b, c)] -> Encoding Source # omitField :: (a, b, c) -> Bool Source #
(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Product f g a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Product f g a -> Value Source # toEncoding :: Product f g a -> Encoding Source # toJSONList :: [Product f g a] -> Value Source # toEncodingList :: [Product f g a] -> Encoding Source # omitField :: Product f g a -> Bool Source #
(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Sum f g a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Sum f g a -> Value Source # toEncoding :: Sum f g a -> Encoding Source # toJSONList :: [Sum f g a] -> Value Source # toEncodingList :: [Sum f g a] -> Encoding Source # omitField :: Sum f g a -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d) => ToJSON (a, b, c, d) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d) -> Value Source # toEncoding :: (a, b, c, d) -> Encoding Source # toJSONList :: [(a, b, c, d)] -> Value Source # toEncodingList :: [(a, b, c, d)] -> Encoding Source # omitField :: (a, b, c, d) -> Bool Source #
(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Compose f g a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Compose f g a -> Value Source # toEncoding :: Compose f g a -> Encoding Source # toJSONList :: [Compose f g a] -> Value Source # toEncodingList :: [Compose f g a] -> Encoding Source # omitField :: Compose f g a -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e) => ToJSON (a, b, c, d, e) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e) -> Value Source # toEncoding :: (a, b, c, d, e) -> Encoding Source # toJSONList :: [(a, b, c, d, e)] -> Value Source # toEncodingList :: [(a, b, c, d, e)] -> Encoding Source # omitField :: (a, b, c, d, e) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f) => ToJSON (a, b, c, d, e, f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f) -> Value Source # toEncoding :: (a, b, c, d, e, f) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f)] -> Encoding Source # omitField :: (a, b, c, d, e, f) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g) => ToJSON (a, b, c, d, e, f, g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f, g) -> Value Source # toEncoding :: (a, b, c, d, e, f, g) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f, g)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f, g)] -> Encoding Source # omitField :: (a, b, c, d, e, f, g) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h) => ToJSON (a, b, c, d, e, f, g, h) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f, g, h) -> Value Source # toEncoding :: (a, b, c, d, e, f, g, h) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f, g, h)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f, g, h)] -> Encoding Source # omitField :: (a, b, c, d, e, f, g, h) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i) => ToJSON (a, b, c, d, e, f, g, h, i) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f, g, h, i) -> Value Source # toEncoding :: (a, b, c, d, e, f, g, h, i) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f, g, h, i)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f, g, h, i)] -> Encoding Source # omitField :: (a, b, c, d, e, f, g, h, i) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j) => ToJSON (a, b, c, d, e, f, g, h, i, j) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f, g, h, i, j) -> Value Source # toEncoding :: (a, b, c, d, e, f, g, h, i, j) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f, g, h, i, j)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f, g, h, i, j)] -> Encoding Source # omitField :: (a, b, c, d, e, f, g, h, i, j) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k) => ToJSON (a, b, c, d, e, f, g, h, i, j, k) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: (a, b, c, d, e, f, g, h, i, j, k) -> Value Source # toEncoding :: (a, b, c, d, e, f, g, h, i, j, k) -> Encoding Source # toJSONList :: [(a, b, c, d, e, f, g, h, i, j, k)] -> Value Source # toEncodingList :: [(a, b, c, d, e, f, g, h, i, j, k)] -> Encoding Source # omitField :: (a, b, c, d, e, f, g, h, i, j, k) -> Bool Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l) => ToJSON (a, b, c, d, e, f, g, h, i, j, k, l) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h, i, j, k, l) -> Value Source #

toEncoding :: (a, b, c, d, e, f, g, h, i, j, k, l) -> Encoding Source #

toJSONList :: [(a, b, c, d, e, f, g, h, i, j, k, l)] -> Value Source #

toEncodingList :: [(a, b, c, d, e, f, g, h, i, j, k, l)] -> Encoding Source #

omitField :: (a, b, c, d, e, f, g, h, i, j, k, l) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m) => ToJSON (a, b, c, d, e, f, g, h, i, j, k, l, m) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h, i, j, k, l, m) -> Value Source #

toEncoding :: (a, b, c, d, e, f, g, h, i, j, k, l, m) -> Encoding Source #

toJSONList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m)] -> Value Source #

toEncodingList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m)] -> Encoding Source #

omitField :: (a, b, c, d, e, f, g, h, i, j, k, l, m) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m, ToJSON n) => ToJSON (a, b, c, d, e, f, g, h, i, j, k, l, m, n) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n) -> Value Source #

toEncoding :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n) -> Encoding Source #

toJSONList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m, n)] -> Value Source #

toEncodingList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m, n)] -> Encoding Source #

omitField :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m, ToJSON n, ToJSON o) => ToJSON (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) -> Value Source #

toEncoding :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) -> Encoding Source #

toJSONList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)] -> Value Source #

toEncodingList :: [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)] -> Encoding Source #

omitField :: (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) -> Bool Source #

class KeyValue e kv | kv -> e where Source #

A key-value pair for encoding a JSON object.

Methods

(.=) :: ToJSON v => Key -> v -> kv infixr 8 Source #

explicitToField :: (v -> e) -> Key -> v -> kv Source #

Since: 2.2.0.0

#### Instances

Instances details

KeyValue Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> Series Source # explicitToField :: (v -> Encoding) -> Key -> v -> Series Source #
value ~ Value => KeyValue Value (KeyMap value) Source # | Constructs a singleton `KeyMap`. For calling functions that demand an `Object` for constructing objects. To be used in conjunction with `mconcat`. Prefer to use `object` where possible.
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> KeyMap value Source # explicitToField :: (v -> Value) -> Key -> v -> KeyMap value Source #
(key ~ Key, value ~ Value) => KeyValue Value (key, value) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> (key, value) Source # explicitToField :: (v -> Value) -> Key -> v -> (key, value) Source #

class KeyValue e kv => KeyValueOmit e kv | kv -> e where Source #

An optional key-value pair for envoding to a JSON object

Since: 2.2.0.0

Methods

(.?=) :: ToJSON v => Key -> v -> kv infixr 8 Source #

explicitToFieldOmit :: (v -> Bool) -> (v -> e) -> Key -> v -> kv Source #

#### Instances

Instances details

KeyValueOmit Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.?=) :: ToJSON v => Key -> v -> Series Source # explicitToFieldOmit :: (v -> Bool) -> (v -> Encoding) -> Key -> v -> Series Source #
value ~ Value => KeyValueOmit Value (KeyMap value) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.?=) :: ToJSON v => Key -> v -> KeyMap value Source # explicitToFieldOmit :: (v -> Bool) -> (v -> Value) -> Key -> v -> KeyMap value Source #

(<?>) :: Parser a -> JSONPathElement -> Parser a Source #

Add JSON Path context to a parser

When parsing a complex structure, it helps to annotate (sub)parsers with context, so that if an error occurs, you can find its location.

    withObject "Person" $ \o ->
      Person
        <$> o .: "name" <?> Key "name"
        <*> o .: "age"  <?> Key "age"

(Standard methods like `(.:)` already do this.)

With such annotations, if an error occurs, you will get a JSON Path location of that error.

Since 0.10

type JSONPath = [JSONPathElement] Source #

## Keys for maps

class ToJSONKey a where Source #

Typeclass for types that can be used as the key of a map-like container (like `Map` or `HashMap`). For example, since `Text` has a `ToJSONKey` instance and `Char` has a `ToJSON` instance, we can encode a value of type `Map` `Text` `Char`:

    >>> LBC8.putStrLn $ encode $ Map.fromList [("foo" :: Text, 'a')]
    {"foo":"a"}

Since `Int` also has a `ToJSONKey` instance, we can similarly write:

    >>> LBC8.putStrLn $ encode $ Map.fromList [(5 :: Int, 'a')]
    {"5":"a"}

JSON documents only accept strings as object keys. For any type from `base` that has a natural textual representation, it can be expected that its `ToJSONKey` instance will choose that representation.

For data types that lack a natural textual representation, an alternative is provided. The map-like container is represented as a JSON array instead of a JSON object. Each value in the array is an array with exactly two values. The first is the key and the second is the value.

For example, values of type '[Text]' cannot be encoded to a string, so a `Map` with keys of type '[Text]' is encoded as follows:

    >>> LBC8.putStrLn $ encode $ Map.fromList [(["foo","bar","baz" :: Text], 'a')]
    [[["foo","bar","baz"],"a"]]

The default implementation of `ToJSONKey` chooses this method of encoding a key, using the `ToJSON` instance of the type.

To use your own data type as the key in a map, all that is needed is to write a `ToJSONKey` (and possibly a `FromJSONKey`) instance for it. If the type cannot be trivially converted to and from `Text`, it is recommended that `ToJSONKeyValue` is used. Since the default implementations of the typeclass methods can build this from a `ToJSON` instance, there is nothing that needs to be written:

    data Foo = Foo { fooAge :: Int, fooName :: Text }
      deriving (Eq,Ord,Generic)
    instance ToJSON Foo
    instance ToJSONKey Foo

That's it. We can now write:

    >>> let m = Map.fromList [(Foo 4 "bar",'a'),(Foo 6 "arg",'b')]
    >>> LBC8.putStrLn $ encode m
    [[{"fooName":"bar","fooAge":4},"a"],[{"fooName":"arg","fooAge":6},"b"]]

The next case to consider is if we have a type that is a newtype wrapper around `Text`. The recommended approach is to use generalized newtype deriving:

    newtype RecordId = RecordId { getRecordId :: Text }
      deriving (Eq,Ord,ToJSONKey)

Then we may write:

    >>> LBC8.putStrLn $ encode $ Map.fromList [(RecordId "abc",'a')]
    {"abc":"a"}

Simple sum types are a final case worth considering. Suppose we have:

    data Color = Red | Green | Blue
      deriving (Show,Read,Eq,Ord)

It is possible to get the `ToJSONKey` instance for free as we did with `Foo`. However, in this case, we have a natural way to go to and from `Text` that does not require any escape sequences. So `ToJSONKeyText` can be used instead of `ToJSONKeyValue` to encode maps as objects instead of arrays of pairs. This instance may be implemented using generics as follows:

    instance ToJSONKey Color where
      toJSONKey = genericToJSONKey defaultJSONKeyOptions

### Low-level implementations

Expand

The `Show` instance can be used to help write `ToJSONKey`:

    instance ToJSONKey Color where
      toJSONKey = ToJSONKeyText f g
        where f = Text.pack . show
              g = text . Text.pack . show
              -- text function is from Data.Aeson.Encoding

The situation of needing to turning function `a -> Text` into a `ToJSONKeyFunction` is common enough that a special combinator is provided for it. The above instance can be rewritten as:

    instance ToJSONKey Color where
      toJSONKey = toJSONKeyText (Text.pack . show)

The performance of the above instance can be improved by not using `String` as an intermediate step when converting to `Text`. One option for improving performance would be to use template haskell machinery from the `text-show` package. However, even with the approach, the `Encoding` (a wrapper around a bytestring builder) is generated by encoding the `Text` to a `ByteString`, an intermediate step that could be avoided. The fastest possible implementation would be:

    -- Assuming that OverloadedStrings is enabled
    instance ToJSONKey Color where
      toJSONKey = ToJSONKeyText f g
        where f x = case x of {Red -> "Red";Green ->"Green";Blue -> "Blue"}
              g x = case x of {Red -> text "Red";Green -> text "Green";Blue -> text "Blue"}
              -- text function is from Data.Aeson.Encoding

This works because GHC can lift the encoded values out of the case statements, which means that they are only evaluated once. This approach should only be used when there is a serious need to maximize performance.

Minimal complete definition

Nothing

Methods

toJSONKey :: ToJSONKeyFunction a Source #

Strategy for rendering the key for a map-like container.

default toJSONKey :: ToJSON a => ToJSONKeyFunction a Source #

toJSONKeyList :: ToJSONKeyFunction [a] Source #

This is similar in spirit to the `showsList` method of `Show`. It makes it possible to give `String` keys special treatment without using `OverlappingInstances`. End users should always be able to use the default implementation of this method.

default toJSONKeyList :: ToJSON a => ToJSONKeyFunction [a] Source #

#### Instances

Instances details

ToJSONKey Key Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Key Source # toJSONKeyList :: ToJSONKeyFunction [Key] Source #
ToJSONKey Void Source # | Since: 2.1.2.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Void Source # toJSONKeyList :: ToJSONKeyFunction [Void] Source #
ToJSONKey Version Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Version Source # toJSONKeyList :: ToJSONKeyFunction [Version] Source #
ToJSONKey Int16 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Int16 Source # toJSONKeyList :: ToJSONKeyFunction [Int16] Source #
ToJSONKey Int32 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Int32 Source # toJSONKeyList :: ToJSONKeyFunction [Int32] Source #
ToJSONKey Int64 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Int64 Source # toJSONKeyList :: ToJSONKeyFunction [Int64] Source #
ToJSONKey Int8 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Int8 Source # toJSONKeyList :: ToJSONKeyFunction [Int8] Source #
ToJSONKey Word16 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Word16 Source # toJSONKeyList :: ToJSONKeyFunction [Word16] Source #
ToJSONKey Word32 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Word32 Source # toJSONKeyList :: ToJSONKeyFunction [Word32] Source #
ToJSONKey Word64 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Word64 Source # toJSONKeyList :: ToJSONKeyFunction [Word64] Source #
ToJSONKey Word8 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Word8 Source # toJSONKeyList :: ToJSONKeyFunction [Word8] Source #
ToJSONKey URI Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction URI Source # toJSONKeyList :: ToJSONKeyFunction [URI] Source #
ToJSONKey Scientific Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Scientific Source # toJSONKeyList :: ToJSONKeyFunction [Scientific] Source #
ToJSONKey Text Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Text Source # toJSONKeyList :: ToJSONKeyFunction [Text] Source #
ToJSONKey Text Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Text Source # toJSONKeyList :: ToJSONKeyFunction [Text] Source #
ToJSONKey ShortText Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction ShortText Source # toJSONKeyList :: ToJSONKeyFunction [ShortText] Source #
ToJSONKey Day Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Day Source # toJSONKeyList :: ToJSONKeyFunction [Day] Source #
ToJSONKey Month Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Month Source # toJSONKeyList :: ToJSONKeyFunction [Month] Source #
ToJSONKey Quarter Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Quarter Source # toJSONKeyList :: ToJSONKeyFunction [Quarter] Source #
ToJSONKey QuarterOfYear Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction QuarterOfYear Source # toJSONKeyList :: ToJSONKeyFunction [QuarterOfYear] Source #
ToJSONKey DayOfWeek Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction DayOfWeek Source # toJSONKeyList :: ToJSONKeyFunction [DayOfWeek] Source #
ToJSONKey UTCTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction UTCTime Source # toJSONKeyList :: ToJSONKeyFunction [UTCTime] Source #
ToJSONKey LocalTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction LocalTime Source # toJSONKeyList :: ToJSONKeyFunction [LocalTime] Source #
ToJSONKey TimeOfDay Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction TimeOfDay Source # toJSONKeyList :: ToJSONKeyFunction [TimeOfDay] Source #
ToJSONKey ZonedTime Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction ZonedTime Source # toJSONKeyList :: ToJSONKeyFunction [ZonedTime] Source #
ToJSONKey UUID Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction UUID Source # toJSONKeyList :: ToJSONKeyFunction [UUID] Source #
ToJSONKey Integer Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Integer Source # toJSONKeyList :: ToJSONKeyFunction [Integer] Source #
ToJSONKey Natural Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Natural Source # toJSONKeyList :: ToJSONKeyFunction [Natural] Source #
ToJSONKey Bool Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Bool Source # toJSONKeyList :: ToJSONKeyFunction [Bool] Source #
ToJSONKey Char Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Char Source # toJSONKeyList :: ToJSONKeyFunction [Char] Source #
ToJSONKey Double Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Double Source # toJSONKeyList :: ToJSONKeyFunction [Double] Source #
ToJSONKey Float Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Float Source # toJSONKeyList :: ToJSONKeyFunction [Float] Source #
ToJSONKey Int Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Int Source # toJSONKeyList :: ToJSONKeyFunction [Int] Source #
ToJSONKey Word Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Word Source # toJSONKeyList :: ToJSONKeyFunction [Word] Source #
ToJSONKey a => ToJSONKey (Identity a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (Identity a) Source # toJSONKeyList :: ToJSONKeyFunction [Identity a] Source #
ToJSONKey a => ToJSONKey (Solo a) Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (Solo a) Source # toJSONKeyList :: ToJSONKeyFunction [Solo a] Source #
(ToJSONKey a, ToJSON a) => ToJSONKey [a] Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction [a] Source # toJSONKeyList :: ToJSONKeyFunction [[a]] Source #
HasResolution a => ToJSONKey (Fixed a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (Fixed a) Source # toJSONKeyList :: ToJSONKeyFunction [Fixed a] Source #
(ToJSON a, ToJSON b) => ToJSONKey (a, b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (a, b) Source # toJSONKeyList :: ToJSONKeyFunction [(a, b)] Source #
(ToJSON a, ToJSONKey a) => ToJSONKey (Const a b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (Const a b) Source # toJSONKeyList :: ToJSONKeyFunction [Const a b] Source #
ToJSONKey b => ToJSONKey (Tagged a b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (Tagged a b) Source # toJSONKeyList :: ToJSONKeyFunction [Tagged a b] Source #
(ToJSON a, ToJSON b, ToJSON c) => ToJSONKey (a, b, c) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (a, b, c) Source # toJSONKeyList :: ToJSONKeyFunction [(a, b, c)] Source #
(ToJSON a, ToJSON b, ToJSON c, ToJSON d) => ToJSONKey (a, b, c, d) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction (a, b, c, d) Source # toJSONKeyList :: ToJSONKeyFunction [(a, b, c, d)] Source #

data ToJSONKeyFunction a Source #

Constructors

ToJSONKeyText !(a -> Key) !(a -> Encoding' Key) | key is encoded to string, produces object
ToJSONKeyValue !(a -> Value) !(a -> Encoding) | key is encoded to value, produces array

#### Instances

Instances details

Contravariant ToJSONKeyFunction Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods contramap :: (a' -> a) -> ToJSONKeyFunction a -> ToJSONKeyFunction a' Source # (>$) :: b -> ToJSONKeyFunction b -> ToJSONKeyFunction a Source #

class FromJSONKey a where Source #

Read the docs for `ToJSONKey` first. This class is a conversion in the opposite direction. If you have a newtype wrapper around `Text`, the recommended way to define instances is with generalized newtype deriving:

    newtype SomeId = SomeId { getSomeId :: Text }
      deriving (Eq,Ord,Hashable,FromJSONKey)

If you have a sum of nullary constructors, you may use the generic implementation:

    data Color = Red | Green | Blue
      deriving Generic

    instance FromJSONKey Color where
      fromJSONKey = genericFromJSONKey defaultJSONKeyOptions

Minimal complete definition

Nothing

Methods

fromJSONKey :: FromJSONKeyFunction a Source #

Strategy for parsing the key of a map-like container.

default fromJSONKey :: FromJSON a => FromJSONKeyFunction a Source #

fromJSONKeyList :: FromJSONKeyFunction [a] Source #

This is similar in spirit to the `readList` method of `Read`. It makes it possible to give `String` keys special treatment without using `OverlappingInstances`. End users should always be able to use the default implementation of this method.

default fromJSONKeyList :: FromJSON a => FromJSONKeyFunction [a] Source #

#### Instances

Instances details

FromJSONKey Key Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Key Source # fromJSONKeyList :: FromJSONKeyFunction [Key] Source #
FromJSONKey Void Source # | Since: 2.1.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Void Source # fromJSONKeyList :: FromJSONKeyFunction [Void] Source #
FromJSONKey Version Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Version Source # fromJSONKeyList :: FromJSONKeyFunction [Version] Source #
FromJSONKey Int16 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Int16 Source # fromJSONKeyList :: FromJSONKeyFunction [Int16] Source #
FromJSONKey Int32 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Int32 Source # fromJSONKeyList :: FromJSONKeyFunction [Int32] Source #
FromJSONKey Int64 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Int64 Source # fromJSONKeyList :: FromJSONKeyFunction [Int64] Source #
FromJSONKey Int8 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Int8 Source # fromJSONKeyList :: FromJSONKeyFunction [Int8] Source #
FromJSONKey Word16 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Word16 Source # fromJSONKeyList :: FromJSONKeyFunction [Word16] Source #
FromJSONKey Word32 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Word32 Source # fromJSONKeyList :: FromJSONKeyFunction [Word32] Source #
FromJSONKey Word64 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Word64 Source # fromJSONKeyList :: FromJSONKeyFunction [Word64] Source #
FromJSONKey Word8 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Word8 Source # fromJSONKeyList :: FromJSONKeyFunction [Word8] Source #
FromJSONKey URI Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction URI Source # fromJSONKeyList :: FromJSONKeyFunction [URI] Source #
FromJSONKey Text Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Text Source # fromJSONKeyList :: FromJSONKeyFunction [Text] Source #
FromJSONKey Text Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Text Source # fromJSONKeyList :: FromJSONKeyFunction [Text] Source #
FromJSONKey ShortText Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction ShortText Source # fromJSONKeyList :: FromJSONKeyFunction [ShortText] Source #
FromJSONKey Day Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Day Source # fromJSONKeyList :: FromJSONKeyFunction [Day] Source #
FromJSONKey Month Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Month Source # fromJSONKeyList :: FromJSONKeyFunction [Month] Source #
FromJSONKey Quarter Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Quarter Source # fromJSONKeyList :: FromJSONKeyFunction [Quarter] Source #
FromJSONKey QuarterOfYear Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction QuarterOfYear Source # fromJSONKeyList :: FromJSONKeyFunction [QuarterOfYear] Source #
FromJSONKey DayOfWeek Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction DayOfWeek Source # fromJSONKeyList :: FromJSONKeyFunction [DayOfWeek] Source #
FromJSONKey UTCTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction UTCTime Source # fromJSONKeyList :: FromJSONKeyFunction [UTCTime] Source #
FromJSONKey LocalTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction LocalTime Source # fromJSONKeyList :: FromJSONKeyFunction [LocalTime] Source #
FromJSONKey TimeOfDay Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction TimeOfDay Source # fromJSONKeyList :: FromJSONKeyFunction [TimeOfDay] Source #
FromJSONKey ZonedTime Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction ZonedTime Source # fromJSONKeyList :: FromJSONKeyFunction [ZonedTime] Source #
FromJSONKey UUID Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction UUID Source # fromJSONKeyList :: FromJSONKeyFunction [UUID] Source #
FromJSONKey Integer Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Integer Source # fromJSONKeyList :: FromJSONKeyFunction [Integer] Source #
FromJSONKey Natural Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Natural Source # fromJSONKeyList :: FromJSONKeyFunction [Natural] Source #
FromJSONKey Bool Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Bool Source # fromJSONKeyList :: FromJSONKeyFunction [Bool] Source #
FromJSONKey Char Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Char Source # fromJSONKeyList :: FromJSONKeyFunction [Char] Source #
FromJSONKey Double Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Double Source # fromJSONKeyList :: FromJSONKeyFunction [Double] Source #
FromJSONKey Float Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Float Source # fromJSONKeyList :: FromJSONKeyFunction [Float] Source #
FromJSONKey Int Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Int Source # fromJSONKeyList :: FromJSONKeyFunction [Int] Source #
FromJSONKey Word Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction Word Source # fromJSONKeyList :: FromJSONKeyFunction [Word] Source #
FromJSONKey a => FromJSONKey (Identity a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (Identity a) Source # fromJSONKeyList :: FromJSONKeyFunction [Identity a] Source #
FromJSONKey a => FromJSONKey (Solo a) Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (Solo a) Source # fromJSONKeyList :: FromJSONKeyFunction [Solo a] Source #
(FromJSONKey a, FromJSON a) => FromJSONKey [a] Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction [a] Source # fromJSONKeyList :: FromJSONKeyFunction [[a]] Source #
(FromJSON a, FromJSON b) => FromJSONKey (a, b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (a, b) Source # fromJSONKeyList :: FromJSONKeyFunction [(a, b)] Source #
(FromJSON a, FromJSONKey a) => FromJSONKey (Const a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (Const a b) Source # fromJSONKeyList :: FromJSONKeyFunction [Const a b] Source #
FromJSONKey b => FromJSONKey (Tagged a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (Tagged a b) Source # fromJSONKeyList :: FromJSONKeyFunction [Tagged a b] Source #
(FromJSON a, FromJSON b, FromJSON c) => FromJSONKey (a, b, c) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (a, b, c) Source # fromJSONKeyList :: FromJSONKeyFunction [(a, b, c)] Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSONKey (a, b, c, d) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction (a, b, c, d) Source # fromJSONKeyList :: FromJSONKeyFunction [(a, b, c, d)] Source #

data FromJSONKeyFunction a where Source #

This type is related to `ToJSONKeyFunction`. If `FromJSONKeyValue` is used in the `FromJSONKey` instance, then `ToJSONKeyValue` should be used in the `ToJSONKey` instance. The other three data constructors for this type all correspond to `ToJSONKeyText`. Strictly speaking, `FromJSONKeyTextParser` is more powerful than `FromJSONKeyText`, which is in turn more powerful than `FromJSONKeyCoerce`. For performance reasons, these exist as three options instead of one.

Constructors

FromJSONKeyCoerce |

Fields

- :: forall a. Coercible Text a
- => FromJSONKeyFunction a

  uses `coerce`, we expect that `Hashable` and `Ord` instance are compatible.

FromJSONKeyText |

Fields

- :: forall a. !(Text -> a)
- -> FromJSONKeyFunction a

  conversion from `Text` that always succeeds

FromJSONKeyTextParser |

Fields

- :: forall a. !(Text -> Parser a)
- -> FromJSONKeyFunction a

  conversion from `Text` that may fail

FromJSONKeyValue |

Fields

- :: forall a. !(Value -> Parser a)
- -> FromJSONKeyFunction a

  conversion for non-textual keys

#### Instances

Instances details

Functor FromJSONKeyFunction Source # | Only law abiding up to interpretation
Instance details Defined in Data.Aeson.Types.FromJSON Methods fmap :: (a -> b) -> FromJSONKeyFunction a -> FromJSONKeyFunction b Source # (<$) :: a -> FromJSONKeyFunction b -> FromJSONKeyFunction a Source #

### Generic keys

class GetConName f => GToJSONKey (f :: k -> Type) Source #

#### Instances

Instances details

GetConName f => GToJSONKey (f :: k -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON

genericToJSONKey :: (Generic a, GToJSONKey (Rep a)) => JSONKeyOptions -> ToJSONKeyFunction a Source #

class (ConstructorNames f, SumFromString f) => GFromJSONKey (f :: Type -> Type) Source #

#### Instances

Instances details

(ConstructorNames f, SumFromString f) => GFromJSONKey f Source # |
Instance details Defined in Data.Aeson.Types.FromJSON

genericFromJSONKey :: (Generic a, GFromJSONKey (Rep a)) => JSONKeyOptions -> FromJSONKeyFunction a Source #

`fromJSONKey` for `Generic` types. These types must be sums of nullary constructors, whose names will be used as keys for JSON objects.

See also `genericToJSONKey`.

### Example

Expand

    data Color = Red | Green | Blue
      deriving Generic

    instance FromJSONKey Color where
      fromJSONKey = genericFromJSONKey defaultJSONKeyOptions

## Liftings to unary and binary type constructors

class FromJSON1 (f :: Type -> Type) where Source #

Lifting of the `FromJSON` class to unary type constructors.

Instead of manually writing your `FromJSON1` 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 `liftParseJSON`.

To use the second, simply add a `deriving `Generic1`` clause to your datatype and declare a `FromJSON1` instance for your datatype without giving a definition for `liftParseJSON`.

For example:

    {-# LANGUAGE DeriveGeneric #-}

    import GHC.Generics

    data Pair a b = Pair { pairFst :: a, pairSnd :: b } deriving Generic1

    instance FromJSON a => FromJSON1 (Pair a)

or

    deriving via Generically1 (Pair a) instance FromJSON1 (Pair a)

If the default implementation doesn't give exactly the results you want, you can customize the generic decoding with only a tiny amount of effort, using `genericLiftParseJSON` with your preferred `Options`:

    customOptions = defaultOptions
                    { fieldLabelModifier = map toUpper
                    }

    instance FromJSON a => FromJSON1 (Pair a) where
        liftParseJSON = genericLiftParseJSON customOptions

Minimal complete definition

Nothing

Methods

liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a) Source #

default liftParseJSON :: (Generic1 f, GFromJSON One (Rep1 f)) => Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a) Source #

liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [f a] Source #

liftOmittedField :: Maybe a -> Maybe (f a) Source #

#### Instances

Instances details

FromJSON1 KeyMap Source # | Since: 2.0.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (KeyMap a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [KeyMap a] Source # liftOmittedField :: Maybe a -> Maybe (KeyMap a) Source #
FromJSON1 First Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (First a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [First a] Source # liftOmittedField :: Maybe a -> Maybe (First a) Source #
FromJSON1 Last Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Last a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Last a] Source # liftOmittedField :: Maybe a -> Maybe (Last a) Source #
FromJSON1 Max Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Max a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Max a] Source # liftOmittedField :: Maybe a -> Maybe (Max a) Source #
FromJSON1 Min Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Min a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Min a] Source # liftOmittedField :: Maybe a -> Maybe (Min a) Source #
FromJSON1 WrappedMonoid Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (WrappedMonoid a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [WrappedMonoid a] Source # liftOmittedField :: Maybe a -> Maybe (WrappedMonoid a) Source #
FromJSON1 IntMap Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (IntMap a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [IntMap a] Source # liftOmittedField :: Maybe a -> Maybe (IntMap a) Source #
FromJSON1 Seq Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Seq a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Seq a] Source # liftOmittedField :: Maybe a -> Maybe (Seq a) Source #
FromJSON1 Tree Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Tree a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Tree a] Source # liftOmittedField :: Maybe a -> Maybe (Tree a) Source #
FromJSON1 DNonEmpty Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (DNonEmpty a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [DNonEmpty a] Source # liftOmittedField :: Maybe a -> Maybe (DNonEmpty a) Source #
FromJSON1 DList Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (DList a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [DList a] Source # liftOmittedField :: Maybe a -> Maybe (DList a) Source #
FromJSON1 NonEmpty Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (NonEmpty a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [NonEmpty a] Source # liftOmittedField :: Maybe a -> Maybe (NonEmpty a) Source #
FromJSON1 Identity Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Identity a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Identity a] Source # liftOmittedField :: Maybe a -> Maybe (Identity a) Source #
FromJSON1 First Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (First a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [First a] Source # liftOmittedField :: Maybe a -> Maybe (First a) Source #
FromJSON1 Last Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Last a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Last a] Source # liftOmittedField :: Maybe a -> Maybe (Last a) Source #
FromJSON1 Down Source # | Since: 2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Down a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Down a] Source # liftOmittedField :: Maybe a -> Maybe (Down a) Source #
FromJSON1 Dual Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Dual a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Dual a] Source # liftOmittedField :: Maybe a -> Maybe (Dual a) Source #
FromJSON1 Product Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Product a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Product a] Source # liftOmittedField :: Maybe a -> Maybe (Product a) Source #
FromJSON1 Sum Source # | Since: 2.2.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Sum a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Sum a] Source # liftOmittedField :: Maybe a -> Maybe (Sum a) Source #
FromJSON1 Maybe Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Maybe a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Maybe a] Source # liftOmittedField :: Maybe a -> Maybe (Maybe a) Source #
FromJSON1 Vector Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Vector a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Vector a] Source # liftOmittedField :: Maybe a -> Maybe (Vector a) Source #
FromJSON1 Maybe Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Maybe a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Maybe a] Source # liftOmittedField :: Maybe a -> Maybe (Maybe a) Source #
FromJSON1 Solo Source # | Since: 2.0.2.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Solo a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Solo a] Source # liftOmittedField :: Maybe a -> Maybe (Solo a) Source #
FromJSON1 [] Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [a] Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [[a]] Source # liftOmittedField :: Maybe a -> Maybe [a] Source #
(FromJSONKey k, Ord k) => FromJSON1 (Map k) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Map k a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Map k a] Source # liftOmittedField :: Maybe a -> Maybe (Map k a) Source #
FromJSON a => FromJSON1 (Either a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (Either a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [Either a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (Either a a0) Source #
FromJSON1 (Proxy :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Proxy a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Proxy a] Source # liftOmittedField :: Maybe a -> Maybe (Proxy a) Source #
FromJSON a => FromJSON1 (Either a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (Either a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [Either a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (Either a a0) Source #
FromJSON a => FromJSON1 (These a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (These a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [These a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (These a a0) Source #
FromJSON a => FromJSON1 (Pair a) Source # | Since: 1.5.3.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (Pair a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [Pair a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (Pair a a0) Source #
FromJSON a => FromJSON1 (These a) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (These a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [These a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (These a a0) Source #
(FromJSONKey k, Eq k, Hashable k) => FromJSON1 (HashMap k) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (HashMap k a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [HashMap k a] Source # liftOmittedField :: Maybe a -> Maybe (HashMap k a) Source #
FromJSON a => FromJSON1 ((,) a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, a0) Source #
FromJSON a => FromJSON1 (Const a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (Const a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [Const a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (Const a a0) Source #
(Generic1 f, GFromJSON One (Rep1 f)) => FromJSON1 (Generically1 f) Source # | Since: 2.1.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Generically1 f a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Generically1 f a] Source # liftOmittedField :: Maybe a -> Maybe (Generically1 f a) Source #
FromJSON1 (Tagged a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (Tagged a a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [Tagged a a0] Source # liftOmittedField :: Maybe a0 -> Maybe (Tagged a a0) Source #
(FromJSON1 f, FromJSON1 g) => FromJSON1 (These1 f g) Source # | Since: 1.5.1.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (These1 f g a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [These1 f g a] Source # liftOmittedField :: Maybe a -> Maybe (These1 f g a) Source #
(FromJSON a, FromJSON b) => FromJSON1 ((,,) a b) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, a0) Source #
(FromJSON1 f, FromJSON1 g) => FromJSON1 (Product f g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Product f g a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Product f g a] Source # liftOmittedField :: Maybe a -> Maybe (Product f g a) Source #
(FromJSON1 f, FromJSON1 g) => FromJSON1 (Sum f g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Sum f g a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Sum f g a] Source # liftOmittedField :: Maybe a -> Maybe (Sum f g a) Source #
(FromJSON a, FromJSON b, FromJSON c) => FromJSON1 ((,,,) a b c) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, c, a0) Source #
(FromJSON1 f, FromJSON1 g) => FromJSON1 (Compose f g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (Compose f g a) Source # liftParseJSONList :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [Compose f g a] Source # liftOmittedField :: Maybe a -> Maybe (Compose f g a) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSON1 ((,,,,) a b c d) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, a0) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e) => FromJSON1 ((,,,,,) a b c d e) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, a0) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f) => FromJSON1 ((,,,,,,) a b c d e f) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, a0) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g) => FromJSON1 ((,,,,,,,) a b c d e f g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, a0) Source # liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, a0)] Source # liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, a0) Source #
(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h) => FromJSON1 ((,,,,,,,,) a b c d e f g h) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i) => FromJSON1 ((,,,,,,,,,) a b c d e f g h i) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j) => FromJSON1 ((,,,,,,,,,,) a b c d e f g h i j) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, j, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k) => FromJSON1 ((,,,,,,,,,,,) a b c d e f g h i j k) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l) => FromJSON1 ((,,,,,,,,,,,,) a b c d e f g h i j k l) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, l, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m) => FromJSON1 ((,,,,,,,,,,,,,) a b c d e f g h i j k l m) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m, a0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m, FromJSON n) => FromJSON1 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m n) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0) Source #

liftParseJSONList :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0)] Source #

liftOmittedField :: Maybe a0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0) Source #

parseJSON1 :: (FromJSON1 f, FromJSON a) => Value -> Parser (f a) Source #

Lift the standard `parseJSON` function through the type constructor.

omittedField1 :: (FromJSON1 f, FromJSON a) => Maybe (f a) Source #

Since: 2.2.0.0

class FromJSON2 (f :: Type -> Type -> Type) where Source #

Lifting of the `FromJSON` class to binary type constructors.

Instead of manually writing your `FromJSON2` instance, Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time.

Minimal complete definition

liftParseJSON2

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (f a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [f a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (f a b) Source #

#### Instances

Instances details

FromJSON2 Either Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (Either a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [Either a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (Either a b) Source #

FromJSON2 Either Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (Either a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [Either a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (Either a b) Source #

FromJSON2 These Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (These a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [These a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (These a b) Source #

FromJSON2 Pair Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (Pair a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [Pair a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (Pair a b) Source #

FromJSON2 These Source # | Since: 1.5.1.0

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (These a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [These a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (These a b) Source #

FromJSON2 (,) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (a, b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [(a, b)] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (a, b) Source #

FromJSON2 (Const :: Type -> Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (Const a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [Const a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (Const a b) Source #

FromJSON2 (Tagged :: Type -> Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (Tagged a b) Source #

liftParseJSONList2 :: Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [Tagged a b] Source #

liftOmittedField2 :: Maybe a -> Maybe b -> Maybe (Tagged a b) Source #

FromJSON a => FromJSON2 ((,,) a) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser (a, a0, b) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b -> (Value -> Parser b) -> (Value -> Parser [b]) -> Value -> Parser [(a, a0, b)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b -> Maybe (a, a0, b) Source #

(FromJSON a, FromJSON b) => FromJSON2 ((,,,) a b) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c) => FromJSON2 ((,,,,) a b c) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSON2 ((,,,,,) a b c d) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e) => FromJSON2 ((,,,,,,) a b c d e) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f) => FromJSON2 ((,,,,,,,) a b c d e f) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g) => FromJSON2 ((,,,,,,,,) a b c d e f g) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h) => FromJSON2 ((,,,,,,,,,) a b c d e f g h) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i) => FromJSON2 ((,,,,,,,,,,) a b c d e f g h i) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, i, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j) => FromJSON2 ((,,,,,,,,,,,) a b c d e f g h i j) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, i, j, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k) => FromJSON2 ((,,,,,,,,,,,,) a b c d e f g h i j k) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l) => FromJSON2 ((,,,,,,,,,,,,,) a b c d e f g h i j k l) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, l, a0, b0) Source #

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g, FromJSON h, FromJSON i, FromJSON j, FromJSON k, FromJSON l, FromJSON m) => FromJSON2 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m) Source # |

Instance details

Defined in Data.Aeson.Types.FromJSON

Methods

liftParseJSON2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0) Source #

liftParseJSONList2 :: Maybe a0 -> (Value -> Parser a0) -> (Value -> Parser [a0]) -> Maybe b0 -> (Value -> Parser b0) -> (Value -> Parser [b0]) -> Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0)] Source #

liftOmittedField2 :: Maybe a0 -> Maybe b0 -> Maybe (a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0) Source #

parseJSON2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Value -> Parser (f a b) Source #

Lift the standard `parseJSON` function through the type constructor.

omittedField2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Maybe (f a b) Source #

Since: 2.2.0.0

class ToJSON1 (f :: Type -> Type) where Source #

Lifting of the `ToJSON` class to unary type constructors.

Instead of manually writing your `ToJSON1` 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 `toJSON1`.

To use the second, simply add a `deriving `Generic1`` clause to your datatype and declare a `ToJSON1` instance for your datatype without giving definitions for `liftToJSON` or `liftToEncoding`.

For example:

    {-# LANGUAGE DeriveGeneric #-}

    import GHC.Generics

    data Pair a b = Pair { pairFst :: a, pairSnd :: b } deriving Generic1

    instance ToJSON a => ToJSON1 (Pair a)

If the default implementation doesn't give exactly the results you want, you can customize the generic encoding with only a tiny amount of effort, using `genericLiftToJSON` and `genericLiftToEncoding` with your preferred `Options`:

    customOptions = defaultOptions
                    { fieldLabelModifier = map toUpper
                    }

    instance ToJSON a => ToJSON1 (Pair a) where
        liftToJSON     = genericLiftToJSON customOptions
        liftToEncoding = genericLiftToEncoding customOptions

See also `ToJSON`.

Minimal complete definition

Nothing

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> f a -> Value Source #

default liftToJSON :: (Generic1 f, GToJSON' Value One (Rep1 f)) => (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> f a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [f a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> f a -> Encoding Source #

default liftToEncoding :: (Generic1 f, GToJSON' Encoding One (Rep1 f)) => (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> f a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [f a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> f a -> Bool Source #

Since: 2.2.0.0

#### Instances

Instances details

ToJSON1 KeyMap Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> KeyMap a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [KeyMap a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> KeyMap a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [KeyMap a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> KeyMap a -> Bool Source #

ToJSON1 First Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> First a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [First a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> First a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [First a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> First a -> Bool Source #

ToJSON1 Last Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Last a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Last a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Last a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Last a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Last a -> Bool Source #

ToJSON1 Max Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Max a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Max a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Max a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Max a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Max a -> Bool Source #

ToJSON1 Min Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Min a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Min a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Min a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Min a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Min a -> Bool Source #

ToJSON1 WrappedMonoid Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> WrappedMonoid a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [WrappedMonoid a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> WrappedMonoid a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [WrappedMonoid a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> WrappedMonoid a -> Bool Source #

ToJSON1 IntMap Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> IntMap a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [IntMap a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> IntMap a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [IntMap a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> IntMap a -> Bool Source #

ToJSON1 Seq Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Seq a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Seq a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Seq a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Seq a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Seq a -> Bool Source #

ToJSON1 Set Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Set a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Set a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Set a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Set a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Set a -> Bool Source #

ToJSON1 Tree Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Tree a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Tree a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Tree a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Tree a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Tree a -> Bool Source #

ToJSON1 DNonEmpty Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> DNonEmpty a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [DNonEmpty a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> DNonEmpty a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [DNonEmpty a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> DNonEmpty a -> Bool Source #

ToJSON1 DList Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> DList a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [DList a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> DList a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [DList a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> DList a -> Bool Source #

ToJSON1 NonEmpty Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> NonEmpty a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [NonEmpty a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> NonEmpty a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [NonEmpty a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> NonEmpty a -> Bool Source #

ToJSON1 Identity Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Identity a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Identity a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Identity a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Identity a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Identity a -> Bool Source #

ToJSON1 First Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> First a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [First a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> First a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [First a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> First a -> Bool Source #

ToJSON1 Last Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Last a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Last a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Last a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Last a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Last a -> Bool Source #

ToJSON1 Down Source # | Since: 2.2.0.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Down a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Down a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Down a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Down a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Down a -> Bool Source #

ToJSON1 Dual Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Dual a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Dual a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Dual a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Dual a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Dual a -> Bool Source #

ToJSON1 Product Source # | Since: 2.2.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Product a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Product a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Product a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Product a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Product a -> Bool Source #

ToJSON1 Sum Source # | Since: 2.2.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Sum a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Sum a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Sum a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Sum a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Sum a -> Bool Source #

ToJSON1 Maybe Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Maybe a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Maybe a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Maybe a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Maybe a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Maybe a -> Bool Source #

ToJSON1 HashSet Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> HashSet a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [HashSet a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> HashSet a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [HashSet a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> HashSet a -> Bool Source #

ToJSON1 Vector Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Vector a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Vector a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Vector a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Vector a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Vector a -> Bool Source #

ToJSON1 Maybe Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Maybe a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Maybe a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Maybe a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Maybe a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Maybe a -> Bool Source #

ToJSON1 Solo Source # | Since: 2.0.2.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Solo a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Solo a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Solo a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Solo a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Solo a -> Bool Source #

ToJSON1 [] Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [a] -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [[a]] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [a] -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [[a]] -> Encoding Source #

liftOmitField :: (a -> Bool) -> [a] -> Bool Source #

ToJSONKey k => ToJSON1 (Map k) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Map k a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Map k a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Map k a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Map k a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Map k a -> Bool Source #

ToJSON a => ToJSON1 (Either a) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> Either a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [Either a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> Either a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [Either a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> Either a a0 -> Bool Source #

ToJSON1 (Proxy :: Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Proxy a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Proxy a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Proxy a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Proxy a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Proxy a -> Bool Source #

ToJSON a => ToJSON1 (Either a) Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> Either a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [Either a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> Either a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [Either a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> Either a a0 -> Bool Source #

ToJSON a => ToJSON1 (These a) Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> These a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [These a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> These a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [These a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> These a a0 -> Bool Source #

ToJSON a => ToJSON1 (Pair a) Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> Pair a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [Pair a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> Pair a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [Pair a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> Pair a a0 -> Bool Source #

ToJSON a => ToJSON1 (These a) Source # | Since: 1.5.1.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> These a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [These a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> These a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [These a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> These a a0 -> Bool Source #

ToJSONKey k => ToJSON1 (HashMap k) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> HashMap k a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [HashMap k a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> HashMap k a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [HashMap k a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> HashMap k a -> Bool Source #

ToJSON a => ToJSON1 ((,) a) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, a0) -> Bool Source #

ToJSON a => ToJSON1 (Const a :: Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> Const a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [Const a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> Const a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [Const a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> Const a a0 -> Bool Source #

(Generic1 f, GToJSON' Value One (Rep1 f), GToJSON' Encoding One (Rep1 f)) => ToJSON1 (Generically1 f) Source # | Since: 2.1.0.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Generically1 f a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Generically1 f a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Generically1 f a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Generically1 f a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Generically1 f a -> Bool Source #

ToJSON1 (Tagged a) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> Tagged a a0 -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [Tagged a a0] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> Tagged a a0 -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [Tagged a a0] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> Tagged a a0 -> Bool Source #

(ToJSON1 f, ToJSON1 g) => ToJSON1 (These1 f g) Source # | Since: 1.5.1.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> These1 f g a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [These1 f g a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> These1 f g a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [These1 f g a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> These1 f g a -> Bool Source #

(ToJSON a, ToJSON b) => ToJSON1 ((,,) a b) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, a0) -> Bool Source #

(ToJSON1 f, ToJSON1 g) => ToJSON1 (Product f g) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Product f g a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Product f g a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Product f g a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Product f g a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Product f g a -> Bool Source #

(ToJSON1 f, ToJSON1 g) => ToJSON1 (Sum f g) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Sum f g a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Sum f g a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Sum f g a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Sum f g a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Sum f g a -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c) => ToJSON1 ((,,,) a b c) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, a0) -> Bool Source #

(ToJSON1 f, ToJSON1 g) => ToJSON1 (Compose f g) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> Compose f g a -> Value Source #

liftToJSONList :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> [Compose f g a] -> Value Source #

liftToEncoding :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> Compose f g a -> Encoding Source #

liftToEncodingList :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> [Compose f g a] -> Encoding Source #

liftOmitField :: (a -> Bool) -> Compose f g a -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d) => ToJSON1 ((,,,,) a b c d) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e) => ToJSON1 ((,,,,,) a b c d e) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f) => ToJSON1 ((,,,,,,) a b c d e f) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g) => ToJSON1 ((,,,,,,,) a b c d e f g) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h) => ToJSON1 ((,,,,,,,,) a b c d e f g h) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i) => ToJSON1 ((,,,,,,,,,) a b c d e f g h i) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j) => ToJSON1 ((,,,,,,,,,,) a b c d e f g h i j) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k) => ToJSON1 ((,,,,,,,,,,,) a b c d e f g h i j k) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l) => ToJSON1 ((,,,,,,,,,,,,) a b c d e f g h i j k l) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, l, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, l, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m) => ToJSON1 ((,,,,,,,,,,,,,) a b c d e f g h i j k l m) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m, ToJSON n) => ToJSON1 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m n) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0) -> Value Source #

liftToJSONList :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0)] -> Value Source #

liftToEncoding :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0) -> Encoding Source #

liftToEncodingList :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0)] -> Encoding Source #

liftOmitField :: (a0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, n, a0) -> Bool Source #

toJSON1 :: (ToJSON1 f, ToJSON a) => f a -> Value Source #

Lift the standard `toJSON` function through the type constructor.

toEncoding1 :: (ToJSON1 f, ToJSON a) => f a -> Encoding Source #

Lift the standard `toEncoding` function through the type constructor.

omitField1 :: (ToJSON1 f, ToJSON a) => f a -> Bool Source #

class ToJSON2 (f :: Type -> Type -> Type) where Source #

Lifting of the `ToJSON` class to binary type constructors.

Instead of manually writing your `ToJSON2` instance, Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time.

The compiler cannot provide a default generic implementation for `liftToJSON2`, unlike `toJSON` and `liftToJSON`.

Minimal complete definition

liftToJSON2, liftToEncoding2

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> f a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [f a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> f a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [f a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> f a b -> Bool Source #

Since: 2.2.0.0

#### Instances

Instances details

ToJSON2 Either Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> Either a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [Either a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> Either a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [Either a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> Either a b -> Bool Source #

ToJSON2 Either Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> Either a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [Either a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> Either a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [Either a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> Either a b -> Bool Source #

ToJSON2 These Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> These a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [These a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> These a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [These a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> These a b -> Bool Source #

ToJSON2 Pair Source # | Since: 1.5.3.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> Pair a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [Pair a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> Pair a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [Pair a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> Pair a b -> Bool Source #

ToJSON2 These Source # | Since: 1.5.1.0

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> These a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [These a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> These a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [These a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> These a b -> Bool Source #

ToJSON2 (,) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> (a, b) -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [(a, b)] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> (a, b) -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [(a, b)] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> (a, b) -> Bool Source #

ToJSON2 (Const :: Type -> Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> Const a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [Const a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> Const a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [Const a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> Const a b -> Bool Source #

ToJSON2 (Tagged :: Type -> Type -> Type) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> Tagged a b -> Value Source #

liftToJSONList2 :: (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [Tagged a b] -> Value Source #

liftToEncoding2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> Tagged a b -> Encoding Source #

liftToEncodingList2 :: (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [Tagged a b] -> Encoding Source #

liftOmitField2 :: (a -> Bool) -> (b -> Bool) -> Tagged a b -> Bool Source #

ToJSON a => ToJSON2 ((,,) a) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> (a, a0, b) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b -> Bool) -> (b -> Value) -> ([b] -> Value) -> [(a, a0, b)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> (a, a0, b) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b -> Bool) -> (b -> Encoding) -> ([b] -> Encoding) -> [(a, a0, b)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b -> Bool) -> (a, a0, b) -> Bool Source #

(ToJSON a, ToJSON b) => ToJSON2 ((,,,) a b) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c) => ToJSON2 ((,,,,) a b c) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d) => ToJSON2 ((,,,,,) a b c d) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e) => ToJSON2 ((,,,,,,) a b c d e) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f) => ToJSON2 ((,,,,,,,) a b c d e f) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g) => ToJSON2 ((,,,,,,,,) a b c d e f g) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h) => ToJSON2 ((,,,,,,,,,) a b c d e f g h) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i) => ToJSON2 ((,,,,,,,,,,) a b c d e f g h i) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, i, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, i, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, i, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j) => ToJSON2 ((,,,,,,,,,,,) a b c d e f g h i j) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k) => ToJSON2 ((,,,,,,,,,,,,) a b c d e f g h i j k) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l) => ToJSON2 ((,,,,,,,,,,,,,) a b c d e f g h i j k l) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, l, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, l, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, l, a0, b0) -> Bool Source #

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g, ToJSON h, ToJSON i, ToJSON j, ToJSON k, ToJSON l, ToJSON m) => ToJSON2 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m) Source # |

Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

liftToJSON2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0) -> Value Source #

liftToJSONList2 :: (a0 -> Bool) -> (a0 -> Value) -> ([a0] -> Value) -> (b0 -> Bool) -> (b0 -> Value) -> ([b0] -> Value) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0)] -> Value Source #

liftToEncoding2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0) -> Encoding Source #

liftToEncodingList2 :: (a0 -> Bool) -> (a0 -> Encoding) -> ([a0] -> Encoding) -> (b0 -> Bool) -> (b0 -> Encoding) -> ([b0] -> Encoding) -> [(a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0)] -> Encoding Source #

liftOmitField2 :: (a0 -> Bool) -> (b0 -> Bool) -> (a, b, c, d, e, f, g, h, i, j, k, l, m, a0, b0) -> Bool Source #

toJSON2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Value Source #

Lift the standard `toJSON` function through the type constructor.

toEncoding2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Encoding Source #

Lift the standard `toEncoding` function through the type constructor.

omitField2 :: (ToJSON2 f, ToJSON a, ToJSON b) => f a b -> Bool Source #

## Generic JSON classes and options

class GFromJSON arity (f :: Type -> Type) Source #

Class of generic representation types that can be converted from JSON.

Minimal complete definition

gParseJSON

#### Instances

Instances details

GFromJSON One Par1 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser (Par1 a)
GFromJSON arity (V1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs arity a -> Value -> Parser (V1 a)
FromJSON1 f => GFromJSON One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser (Rec1 f a)
(GFromJSON' arity a, Datatype d) => GFromJSON arity (D1 d a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs arity a0 -> Value -> Parser (D1 d a a0)
FromJSON a => GFromJSON arity (K1 i a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs arity a0 -> Value -> Parser (K1 i a a0)
(FromJSON1 f, GFromJSON One g) => GFromJSON One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser ((f :.: g) a)
GFromJSON arity a => GFromJSON arity (M1 i c a) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs arity a0 -> Value -> Parser (M1 i c a a0)

data FromArgs arity a Source #

A `FromArgs` value either stores nothing (for `FromJSON`) or it stores the three function arguments that decode occurrences of the type parameter (for `FromJSON1`).

type GToJSON = GToJSON' Value Source #

type GToEncoding = GToJSON' Encoding Source #

class GToJSON' enc arity (f :: Type -> Type) Source #

Class of generic representation types that can be converted to JSON.

Minimal complete definition

gToJSON

#### Instances

Instances details

GToJSON' enc One Par1 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc One a -> Par1 a -> enc
GToJSON' Encoding arity (U1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a -> U1 a -> Encoding
GToJSON' Encoding arity (V1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a -> V1 a -> Encoding
GToJSON' Value arity (U1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a -> U1 a -> Value
GToJSON' Value arity (V1 :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a -> V1 a -> Value
ToJSON1 f => GToJSON' Encoding One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> Rec1 f a -> Encoding
ToJSON1 f => GToJSON' Value One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> Rec1 f a -> Value
(EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a0 -> (a :*: b) a0 -> Encoding
ToJSON a => GToJSON' Encoding arity (K1 i a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding arity a0 -> K1 i a a0 -> Encoding
(WriteProduct arity a, WriteProduct arity b, ProductSize a, ProductSize b) => GToJSON' Value arity (a :*: b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a0 -> (a :*: b) a0 -> Value
ToJSON a => GToJSON' Value arity (K1 i a :: Type -> Type) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value arity a0 -> K1 i a a0 -> Value
(AllNullary (a :+: b) allNullary, SumToJSON enc arity (a :+: b) allNullary) => GToJSON' enc arity (a :+: b) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc arity a0 -> (a :+: b) a0 -> enc
ConsToJSON enc arity a => GToJSON' enc arity (C1 c a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc arity a0 -> C1 c a a0 -> enc
(ConsToJSON enc arity a, AllNullary (C1 c a) allNullary, SumToJSON enc arity (C1 c a) allNullary) => GToJSON' enc arity (D1 d (C1 c a)) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc arity a0 -> D1 d (C1 c a) a0 -> enc
(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> (f :.: g) a -> Encoding
(ToJSON1 f, GToJSON' Value One g) => GToJSON' Value One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> (f :.: g) a -> Value
GToJSON' enc arity a => GToJSON' enc arity (M1 i c a) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc arity a0 -> M1 i c a a0 -> enc

data ToArgs res arity a Source #

A `ToArgs` value either stores nothing (for `ToJSON`) or it stores the three function arguments that encode occurrences of the type parameter (for `ToJSON1`).

data Zero Source #

A type-level indicator that `ToJSON` or `FromJSON` is being derived generically.

data One Source #

A type-level indicator that `ToJSON1` or `FromJSON1` is being derived generically.

#### Instances

Instances details

GFromJSON One Par1 Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser (Par1 a)
GToJSON' enc One Par1 Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs enc One a -> Par1 a -> enc
ToJSON1 f => GToJSON' Encoding One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> Rec1 f a -> Encoding
ToJSON1 f => GToJSON' Value One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> Rec1 f a -> Value
(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Encoding One a -> (f :.: g) a -> Encoding
(ToJSON1 f, GToJSON' Value One g) => GToJSON' Value One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods gToJSON :: Options -> ToArgs Value One a -> (f :.: g) a -> Value
FromJSON1 f => GFromJSON One (Rec1 f) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser (Rec1 f a)
(FromJSON1 f, GFromJSON One g) => GFromJSON One (f :.: g) Source # |
Instance details Defined in Data.Aeson.Types.FromJSON Methods gParseJSON :: Options -> FromArgs One a -> Value -> Parser ((f :.: g) a)

genericToJSON :: (Generic a, GToJSON' Value Zero (Rep a)) => Options -> a -> Value Source #

A configurable generic JSON creator. This function applied to `defaultOptions` is used as the default for `toJSON` when the type is an instance of `Generic`.

genericLiftToJSON :: (Generic1 f, GToJSON' Value One (Rep1 f)) => Options -> (a -> Bool) -> (a -> Value) -> ([a] -> Value) -> f a -> Value Source #

A configurable generic JSON creator. This function applied to `defaultOptions` is used as the default for `liftToJSON` when the type is an instance of `Generic1`.

genericToEncoding :: (Generic a, GToJSON' Encoding Zero (Rep a)) => Options -> a -> Encoding Source #

A configurable generic JSON encoder. This function applied to `defaultOptions` is used as the default for `toEncoding` when the type is an instance of `Generic`.

genericLiftToEncoding :: (Generic1 f, GToJSON' Encoding One (Rep1 f)) => Options -> (a -> Bool) -> (a -> Encoding) -> ([a] -> Encoding) -> f a -> Encoding Source #

A configurable generic JSON encoder. This function applied to `defaultOptions` is used as the default for `liftToEncoding` when the type is an instance of `Generic1`.

genericParseJSON :: (Generic a, GFromJSON Zero (Rep a)) => Options -> Value -> Parser a Source #

A configurable generic JSON decoder. This function applied to `defaultOptions` is used as the default for `parseJSON` when the type is an instance of `Generic`.

genericLiftParseJSON :: (Generic1 f, GFromJSON One (Rep1 f)) => Options -> Maybe a -> (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a) Source #

A configurable generic JSON decoder. This function applied to `defaultOptions` is used as the default for `liftParseJSON` when the type is an instance of `Generic1`.

## Generic and TH encoding configuration

data Options Source #

Options that specify how to encode/decode your datatype to/from JSON.

Options can be set using record syntax on `defaultOptions` with the fields below.

#### Instances

Instances details

Show Options Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> Options -> ShowS Source # show :: Options -> String Source # showList :: [Options] -> ShowS Source #

defaultOptions :: Options Source #

Default encoding `Options`:

    Options
    { fieldLabelModifier      = id
    , constructorTagModifier  = id
    , allNullaryToStringTag   = True
    , omitNothingFields       = False
    , allowOmittedFields      = True
    , sumEncoding             = defaultTaggedObject
    , unwrapUnaryRecords      = False
    , tagSingleConstructors   = False
    , rejectUnknownFields     = False
    }

### Options fields

fieldLabelModifier :: Options -> String -> String Source #

Function applied to field labels. Handy for removing common record prefixes for example.

constructorTagModifier :: Options -> String -> String Source #

Function applied to constructor tags which could be handy for lower-casing them for example.

allNullaryToStringTag :: Options -> Bool Source #

If `True` the constructors of a datatype, with all nullary constructors, will be encoded to just a string with the constructor tag. If `False` the encoding will always follow the `sumEncoding`.

omitNothingFields :: Options -> Bool Source #

If `True`, record fields with a `Nothing` value will be omitted from the resulting object. If `False`, the resulting object will include those fields mapping to `null`.

In `aeson-2.2` this flag is generalised to omit all values with ``omitField` x = True`. If `False`, the resulting object will include those fields encoded as specified.

Note that this does not affect parsing: `Maybe` fields are optional regardless of the value of `omitNothingFields`. `allowOmittedFieds` controls parsing behavior.

allowOmittedFields :: Options -> Bool Source #

If `True`, missing fields of a record will be filled with `omittedField` values (if they are `Just`). If `False`, all fields will required to present in the record object.

sumEncoding :: Options -> SumEncoding Source #

Specifies how to encode constructors of a sum datatype.

unwrapUnaryRecords :: Options -> Bool Source #

Hide the field name when a record constructor has only one field, like a newtype.

tagSingleConstructors :: Options -> Bool Source #

Encode types with a single constructor as sums, so that `allNullaryToStringTag` and `sumEncoding` apply.

rejectUnknownFields :: Options -> Bool Source #

Applies only to `FromJSON` instances. If a field appears in the parsed object map, but does not appear in the target object, parsing will fail, with an error message indicating which fields were unknown.

### Options utilities

data SumEncoding Source #

Specifies how to encode constructors of a sum datatype.

Constructors

TaggedObject

A constructor will be encoded to an object with a field `tagFieldName` which specifies the constructor tag (modified by the `constructorTagModifier`). If the constructor is a record the encoded record fields will be unpacked into this object. So make sure that your record doesn't have a field with the same label as the `tagFieldName`. Otherwise the tag gets overwritten by the encoded value of that field! If the constructor is not a record the encoded constructor contents will be stored under the `contentsFieldName` field.

Fields

- tagFieldName :: String
- contentsFieldName :: String

UntaggedValue

Constructor names won't be encoded. Instead only the contents of the constructor will be encoded as if the type had a single constructor. JSON encodings have to be disjoint for decoding to work properly.

When decoding, constructors are tried in the order of definition. If some encodings overlap, the first one defined will succeed.

Note: Nullary constructors are encoded as strings (using `constructorTagModifier`). Having a nullary constructor alongside a single field constructor that encodes to a string leads to ambiguity.

Note: Only the last error is kept when decoding, so in the case of malformed JSON, only an error for the last constructor will be reported.

ObjectWithSingleField | A constructor will be encoded to an object with a single field named after the constructor tag (modified by the `constructorTagModifier`) which maps to the encoded contents of the constructor.
TwoElemArray | A constructor will be encoded to a 2-element array where the first element is the tag of the constructor (modified by the `constructorTagModifier`) and the second element the encoded contents of the constructor.

#### Instances

Instances details

Show SumEncoding Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods showsPrec :: Int -> SumEncoding -> ShowS Source # show :: SumEncoding -> String Source # showList :: [SumEncoding] -> ShowS Source #
Eq SumEncoding Source # |
Instance details Defined in Data.Aeson.Types.Internal Methods (==) :: SumEncoding -> SumEncoding -> Bool Source # (/=) :: SumEncoding -> SumEncoding -> Bool Source #

camelTo2 :: Char -> String -> String Source #

Better version of `camelTo`. Example where it works better:

    camelTo '_' "CamelAPICase" == "camel_apicase"
    camelTo2 '_' "CamelAPICase" == "camel_api_case"

defaultTaggedObject :: SumEncoding Source #

Default `TaggedObject` `SumEncoding` options:

    defaultTaggedObject = TaggedObject
                          { tagFieldName      = "tag"
                          , contentsFieldName = "contents"
                          }

## Options for object keys

data JSONKeyOptions Source #

Options for encoding keys with `genericFromJSONKey` and `genericToJSONKey`.

keyModifier :: JSONKeyOptions -> String -> String Source #

Function applied to keys. Its result is what goes into the encoded `Value`.

### Example

Expand

The following instances encode the constructor `Bar` to lower-case keys `"bar"`.

    data Foo = Bar
      deriving Generic

    opts :: JSONKeyOptions
    opts = defaultJSONKeyOptions { keyModifier = toLower }

    instance ToJSONKey Foo where
      toJSONKey = genericToJSONKey opts

    instance FromJSONKey Foo where
      fromJSONKey = genericFromJSONKey opts

defaultJSONKeyOptions :: JSONKeyOptions Source #

Default `JSONKeyOptions`:

    defaultJSONKeyOptions = JSONKeyOptions
                            { keyModifier = id
                            }

# Inspecting ``Value`s`

withObject :: String -> (Object -> Parser a) -> Value -> Parser a Source #

``withObject` name f value` applies `f` to the `Object` when `value` is an `Object` and fails otherwise.

#### Error message example

    withObject "MyType" f (String "oops")
    -- Error: "parsing MyType failed, expected Object, but encountered String"

withText :: String -> (Text -> Parser a) -> Value -> Parser a Source #

``withText` name f value` applies `f` to the `Text` when `value` is a `String` and fails otherwise.

#### Error message example

    withText "MyType" f Null
    -- Error: "parsing MyType failed, expected String, but encountered Null"

withArray :: String -> (Array -> Parser a) -> Value -> Parser a Source #

``withArray` expected f value` applies `f` to the `Array` when `value` is an `Array` and fails otherwise.

#### Error message example

    withArray "MyType" f (String "oops")
    -- Error: "parsing MyType failed, expected Array, but encountered String"

withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a Source #

``withScientific` name f value` applies `f` to the `Scientific` number when `value` is a `Number` and fails using `typeMismatch` otherwise.

Warning: If you are converting from a scientific to an unbounded type such as `Integer` you may want to add a restriction on the size of the exponent (see `withBoundedScientific`) to prevent malicious input from filling up the memory of the target system.

#### Error message example

    withScientific "MyType" f (String "oops")
    -- Error: "parsing MyType failed, expected Number, but encountered String"

withBool :: String -> (Bool -> Parser a) -> Value -> Parser a Source #

``withBool` expected f value` applies `f` to the `Bool` when `value` is a `Boolean` and fails otherwise.

#### Error message example

    withBool "MyType" f (String "oops")
    -- Error: "parsing MyType failed, expected Boolean, but encountered String"

withEmbeddedJSON :: String -> (Value -> Parser a) -> Value -> Parser a Source #

Decode a nested JSON-encoded string.

# Constructors and accessors

data Series Source #

A series of values that, when encoded, should be separated by commas. Since 0.11.0.0, the `.=` operator is overloaded to create either `(Text, Value)` or `Series`. You can use Series when encoding directly to a bytestring builder as in the following example:

    toEncoding (Person name age) = pairs ("name" .= name <> "age" .= age)

#### Instances

Instances details

Monoid Series Source # |
Instance details Defined in Data.Aeson.Encoding.Internal Methods mempty :: Series Source # mappend :: Series -> Series -> Series Source # mconcat :: [Series] -> Series Source #
Semigroup Series Source # |
Instance details Defined in Data.Aeson.Encoding.Internal Methods (<>) :: Series -> Series -> Series Source # sconcat :: NonEmpty Series -> Series Source # stimes :: Integral b => b -> Series -> Series Source #
KeyValue Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.=) :: ToJSON v => Key -> v -> Series Source # explicitToField :: (v -> Encoding) -> Key -> v -> Series Source #
KeyValueOmit Encoding Series Source # |
Instance details Defined in Data.Aeson.Types.ToJSON Methods (.?=) :: ToJSON v => Key -> v -> Series Source # explicitToFieldOmit :: (v -> Bool) -> (v -> Encoding) -> Key -> v -> Series Source #

pairs :: Series -> Encoding Source #

Encode a series of key/value pairs, separated by commas.

foldable :: (Foldable t, ToJSON a) => t a -> Encoding Source #

Encode a `Foldable` as a JSON array.

(.:) :: FromJSON a => Object -> Key -> Parser a Source #

Retrieve the value associated with the given key of an `Object`. The result is `empty` if the key is not present or the value cannot be converted to the desired type.

This accessor is appropriate if the key and value must be present in an object for it to be valid. If the key and value are optional, use `.:?` instead.

(.:?) :: FromJSON a => Object -> Key -> Parser (Maybe a) Source #

Retrieve the value associated with the given key of an `Object`. The result is `Nothing` if the key is not present or if its value is `Null`, or `empty` if the value cannot be converted to the desired type.

This accessor is most useful if the key and value can be absent from an object without affecting its validity. If the key and value are mandatory, use `.:` instead.

(.:!) :: FromJSON a => Object -> Key -> Parser (Maybe a) Source #

Retrieve the value associated with the given key of an `Object`. The result is `Nothing` if the key is not present or `empty` if the value cannot be converted to the desired type.

This differs from `.:?` by attempting to parse `Null` the same as any other JSON value, instead of interpreting it as `Nothing`.

(.!=) :: Parser (Maybe a) -> a -> Parser a Source #

Helper for use in combination with `.:?` to provide default values for optional JSON object fields.

This combinator is most useful if the key and value can be absent from an object without affecting its validity and we know a default value to assign in that case. If the key and value are mandatory, use `.:` instead.

Example usage:

     v1 <- o .:? "opt_field_with_dfl" .!= "default_val"
     v2 <- o .:  "mandatory_field"
     v3 <- o .:? "opt_field2"

(.:?=) :: FromJSON a => Object -> Key -> Parser a Source #

Retrieve the value associated with the given key of an `Object`. If the key is not present or the field is `null` and the `omittedField` is ``Just` x` for some `x`, the result will be that `x`.

Since: 2.2.0.0

(.:!=) :: FromJSON a => Object -> Key -> Parser a Source #

Retrieve the value associated with the given key of an `Object`. If the key is not present and the `omittedField` is ``Just` x` for some `x`, the result will be that `x`.

This differs from `.:?=` by attempting to parse `Null` the same as any other JSON value, instead of using `omittedField` when it's `Just`.

Since: 2.2.0.0

object :: [Pair] -> Value Source #

Create a `Value` from a list of name/value `Pair`s. If duplicate keys arise, later keys and their associated values win.

# Parsing

parseIndexedJSON :: (Value -> Parser a) -> Int -> Value -> Parser a Source #