OpenAI.Internal.Aeson

Documentation

jsonOpts :: Int -> Options

deriveJSON

Arguments

:: Options

Encoding options.

-> Name

Name of the type for which to generate ToJSON and FromJSON instances.

-> Q [Dec]

Generates both ToJSON and FromJSON instance declarations for the given data type or data family instance constructor.

This is a convienience function which is equivalent to calling both deriveToJSON and deriveFromJSON.

class ToJSON a

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

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.)

Instances

ToJSON Bool

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Bool -> Value

toEncoding :: Bool -> Encoding

toJSONList :: [Bool] -> Value

toEncodingList :: [Bool] -> Encoding

ToJSON Char

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Char -> Value

toEncoding :: Char -> Encoding

toJSONList :: [Char] -> Value

toEncodingList :: [Char] -> Encoding

ToJSON Double

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Double -> Value

toEncoding :: Double -> Encoding

toJSONList :: [Double] -> Value

toEncodingList :: [Double] -> Encoding

ToJSON Float

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Float -> Value

toEncoding :: Float -> Encoding

toJSONList :: [Float] -> Value

toEncodingList :: [Float] -> Encoding

ToJSON Int

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Int -> Value

toEncoding :: Int -> Encoding

toJSONList :: [Int] -> Value

toEncodingList :: [Int] -> Encoding

ToJSON Int8

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Int8 -> Value

toEncoding :: Int8 -> Encoding

toJSONList :: [Int8] -> Value

toEncodingList :: [Int8] -> Encoding

ToJSON Int16

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Int16 -> Value

toEncoding :: Int16 -> Encoding

toJSONList :: [Int16] -> Value

toEncodingList :: [Int16] -> Encoding

ToJSON Int32

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Int32 -> Value

toEncoding :: Int32 -> Encoding

toJSONList :: [Int32] -> Value

toEncodingList :: [Int32] -> Encoding

ToJSON Int64

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Int64 -> Value

toEncoding :: Int64 -> Encoding

toJSONList :: [Int64] -> Value

toEncodingList :: [Int64] -> Encoding

ToJSON Integer

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Integer -> Value

toEncoding :: Integer -> Encoding

toJSONList :: [Integer] -> Value

toEncodingList :: [Integer] -> Encoding

ToJSON Natural

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Natural -> Value

toEncoding :: Natural -> Encoding

toJSONList :: [Natural] -> Value

toEncodingList :: [Natural] -> Encoding

ToJSON Ordering

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Ordering -> Value

toEncoding :: Ordering -> Encoding

toJSONList :: [Ordering] -> Value

toEncodingList :: [Ordering] -> Encoding

ToJSON Word

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Word -> Value

toEncoding :: Word -> Encoding

toJSONList :: [Word] -> Value

toEncodingList :: [Word] -> Encoding

ToJSON Word8

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Word8 -> Value

toEncoding :: Word8 -> Encoding

toJSONList :: [Word8] -> Value

toEncodingList :: [Word8] -> Encoding

ToJSON Word16

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Word16 -> Value

toEncoding :: Word16 -> Encoding

toJSONList :: [Word16] -> Value

toEncodingList :: [Word16] -> Encoding

ToJSON Word32

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Word32 -> Value

toEncoding :: Word32 -> Encoding

toJSONList :: [Word32] -> Value

toEncodingList :: [Word32] -> Encoding

ToJSON Word64

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Word64 -> Value

toEncoding :: Word64 -> Encoding

toJSONList :: [Word64] -> Value

toEncodingList :: [Word64] -> Encoding

ToJSON ()

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: () -> Value

toEncoding :: () -> Encoding

toJSONList :: [()] -> Value

toEncodingList :: [()] -> Encoding

ToJSON Version

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Version -> Value

toEncoding :: Version -> Encoding

toJSONList :: [Version] -> Value

toEncodingList :: [Version] -> Encoding

ToJSON Scientific

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Scientific -> Value

toEncoding :: Scientific -> Encoding

toJSONList :: [Scientific] -> Value

toEncodingList :: [Scientific] -> Encoding

ToJSON Text

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Text -> Value

toEncoding :: Text -> Encoding

toJSONList :: [Text] -> Value

toEncodingList :: [Text] -> Encoding

ToJSON UTCTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: UTCTime -> Value

toEncoding :: UTCTime -> Encoding

toJSONList :: [UTCTime] -> Value

toEncodingList :: [UTCTime] -> Encoding

ToJSON Value

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Value -> Value

toEncoding :: Value -> Encoding

toJSONList :: [Value] -> Value

toEncodingList :: [Value] -> Encoding

ToJSON DotNetTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: DotNetTime -> Value

toEncoding :: DotNetTime -> Encoding

toJSONList :: [DotNetTime] -> Value

toEncodingList :: [DotNetTime] -> Encoding

ToJSON Text

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Text -> Value

toEncoding :: Text -> Encoding

toJSONList :: [Text] -> Value

toEncodingList :: [Text] -> Encoding

ToJSON Number

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Number -> Value

toEncoding :: Number -> Encoding

toJSONList :: [Number] -> Value

toEncodingList :: [Number] -> Encoding

ToJSON Void

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Void -> Value

toEncoding :: Void -> Encoding

toJSONList :: [Void] -> Value

toEncodingList :: [Void] -> Encoding

ToJSON CTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: CTime -> Value

toEncoding :: CTime -> Encoding

toJSONList :: [CTime] -> Value

toEncodingList :: [CTime] -> Encoding

ToJSON IntSet

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: IntSet -> Value

toEncoding :: IntSet -> Encoding

toJSONList :: [IntSet] -> Value

toEncodingList :: [IntSet] -> Encoding

ToJSON ZonedTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: ZonedTime -> Value

toEncoding :: ZonedTime -> Encoding

toJSONList :: [ZonedTime] -> Value

toEncodingList :: [ZonedTime] -> Encoding

ToJSON LocalTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: LocalTime -> Value

toEncoding :: LocalTime -> Encoding

toJSONList :: [LocalTime] -> Value

toEncodingList :: [LocalTime] -> Encoding

ToJSON TimeOfDay

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: TimeOfDay -> Value

toEncoding :: TimeOfDay -> Encoding

toJSONList :: [TimeOfDay] -> Value

toEncodingList :: [TimeOfDay] -> Encoding

ToJSON CalendarDiffTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: CalendarDiffTime -> Value

toEncoding :: CalendarDiffTime -> Encoding

toJSONList :: [CalendarDiffTime] -> Value

toEncodingList :: [CalendarDiffTime] -> Encoding

ToJSON SystemTime

Encoded as number

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: SystemTime -> Value

toEncoding :: SystemTime -> Encoding

toJSONList :: [SystemTime] -> Value

toEncodingList :: [SystemTime] -> Encoding

ToJSON NominalDiffTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: NominalDiffTime -> Value

toEncoding :: NominalDiffTime -> Encoding

toJSONList :: [NominalDiffTime] -> Value

toEncodingList :: [NominalDiffTime] -> Encoding

ToJSON DiffTime

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: DiffTime -> Value

toEncoding :: DiffTime -> Encoding

toJSONList :: [DiffTime] -> Value

toEncodingList :: [DiffTime] -> Encoding

ToJSON DayOfWeek

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: DayOfWeek -> Value

toEncoding :: DayOfWeek -> Encoding

toJSONList :: [DayOfWeek] -> Value

toEncodingList :: [DayOfWeek] -> Encoding

ToJSON Day

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Day -> Value

toEncoding :: Day -> Encoding

toJSONList :: [Day] -> Value

toEncodingList :: [Day] -> Encoding

ToJSON CalendarDiffDays

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: CalendarDiffDays -> Value

toEncoding :: CalendarDiffDays -> Encoding

toJSONList :: [CalendarDiffDays] -> Value

toEncodingList :: [CalendarDiffDays] -> Encoding

ToJSON QuarterOfYear

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: QuarterOfYear -> Value

toEncoding :: QuarterOfYear -> Encoding

toJSONList :: [QuarterOfYear] -> Value

toEncodingList :: [QuarterOfYear] -> Encoding

ToJSON Quarter

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Quarter -> Value

toEncoding :: Quarter -> Encoding

toJSONList :: [Quarter] -> Value

toEncodingList :: [Quarter] -> Encoding

ToJSON Month

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Month -> Value

toEncoding :: Month -> Encoding

toJSONList :: [Month] -> Value

toEncodingList :: [Month] -> Encoding

ToJSON UUID

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: UUID -> Value

toEncoding :: UUID -> Encoding

toJSONList :: [UUID] -> Value

toEncodingList :: [UUID] -> Encoding

ToJSON AnswerResp

Defined in OpenAI.Resources

Methods

toJSON :: AnswerResp -> Value

toEncoding :: AnswerResp -> Encoding

toJSONList :: [AnswerResp] -> Value

toEncodingList :: [AnswerResp] -> Encoding

ToJSON AnswerReq

Defined in OpenAI.Resources

Methods

toJSON :: AnswerReq -> Value

toEncoding :: AnswerReq -> Encoding

toJSONList :: [AnswerReq] -> Value

toEncodingList :: [AnswerReq] -> Encoding

ToJSON FileDeleteConfirmation

Defined in OpenAI.Resources

Methods

toJSON :: FileDeleteConfirmation -> Value

toEncoding :: FileDeleteConfirmation -> Encoding

toJSONList :: [FileDeleteConfirmation] -> Value

toEncodingList :: [FileDeleteConfirmation] -> Encoding

ToJSON File

Defined in OpenAI.Resources

Methods

toJSON :: File -> Value

toEncoding :: File -> Encoding

toJSONList :: [File] -> Value

toEncodingList :: [File] -> Encoding

ToJSON FileId

Defined in OpenAI.Resources

Methods

toJSON :: FileId -> Value

toEncoding :: FileId -> Encoding

toJSONList :: [FileId] -> Value

toEncodingList :: [FileId] -> Encoding

ToJSON SearchResultCreate

Defined in OpenAI.Resources

Methods

toJSON :: SearchResultCreate -> Value

toEncoding :: SearchResultCreate -> Encoding

toJSONList :: [SearchResultCreate] -> Value

toEncodingList :: [SearchResultCreate] -> Encoding

ToJSON SearchResult

Defined in OpenAI.Resources

Methods

toJSON :: SearchResult -> Value

toEncoding :: SearchResult -> Encoding

toJSONList :: [SearchResult] -> Value

toEncodingList :: [SearchResult] -> Encoding

ToJSON TextCompletionCreate

Defined in OpenAI.Resources

Methods

toJSON :: TextCompletionCreate -> Value

toEncoding :: TextCompletionCreate -> Encoding

toJSONList :: [TextCompletionCreate] -> Value

toEncodingList :: [TextCompletionCreate] -> Encoding

ToJSON TextCompletion

Defined in OpenAI.Resources

Methods

toJSON :: TextCompletion -> Value

toEncoding :: TextCompletion -> Encoding

toJSONList :: [TextCompletion] -> Value

toEncodingList :: [TextCompletion] -> Encoding

ToJSON TextCompletionChoice

Defined in OpenAI.Resources

Methods

toJSON :: TextCompletionChoice -> Value

toEncoding :: TextCompletionChoice -> Encoding

toJSONList :: [TextCompletionChoice] -> Value

toEncodingList :: [TextCompletionChoice] -> Encoding

ToJSON TextCompletionId

Defined in OpenAI.Resources

Methods

toJSON :: TextCompletionId -> Value

toEncoding :: TextCompletionId -> Encoding

toJSONList :: [TextCompletionId] -> Value

toEncodingList :: [TextCompletionId] -> Encoding

ToJSON Engine

Defined in OpenAI.Resources

Methods

toJSON :: Engine -> Value

toEncoding :: Engine -> Encoding

toJSONList :: [Engine] -> Value

toEncodingList :: [Engine] -> Encoding

ToJSON EngineId

Defined in OpenAI.Resources

Methods

toJSON :: EngineId -> Value

toEncoding :: EngineId -> Encoding

toJSONList :: [EngineId] -> Value

toEncodingList :: [EngineId] -> Encoding

ToJSON TimeStamp

Defined in OpenAI.Resources

Methods

toJSON :: TimeStamp -> Value

toEncoding :: TimeStamp -> Encoding

toJSONList :: [TimeStamp] -> Value

toEncodingList :: [TimeStamp] -> Encoding

ToJSON a => ToJSON [a]

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: [a] -> Value

toEncoding :: [a] -> Encoding

toJSONList :: [[a]] -> Value

toEncodingList :: [[a]] -> Encoding

ToJSON a => ToJSON (Maybe a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Maybe a -> Value

toEncoding :: Maybe a -> Encoding

toJSONList :: [Maybe a] -> Value

toEncodingList :: [Maybe a] -> Encoding

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

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Ratio a -> Value

toEncoding :: Ratio a -> Encoding

toJSONList :: [Ratio a] -> Value

toEncodingList :: [Ratio a] -> Encoding

ToJSON a => ToJSON (Min a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Min a -> Value

toEncoding :: Min a -> Encoding

toJSONList :: [Min a] -> Value

toEncodingList :: [Min a] -> Encoding

ToJSON a => ToJSON (Max a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Max a -> Value

toEncoding :: Max a -> Encoding

toJSONList :: [Max a] -> Value

toEncodingList :: [Max a] -> Encoding

ToJSON a => ToJSON (First a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: First a -> Value

toEncoding :: First a -> Encoding

toJSONList :: [First a] -> Value

toEncodingList :: [First a] -> Encoding

ToJSON a => ToJSON (Last a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Last a -> Value

toEncoding :: Last a -> Encoding

toJSONList :: [Last a] -> Value

toEncodingList :: [Last a] -> Encoding

ToJSON a => ToJSON (WrappedMonoid a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: WrappedMonoid a -> Value

toEncoding :: WrappedMonoid a -> Encoding

toJSONList :: [WrappedMonoid a] -> Value

toEncodingList :: [WrappedMonoid a] -> Encoding

ToJSON a => ToJSON (Option a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Option a -> Value

toEncoding :: Option a -> Encoding

toJSONList :: [Option a] -> Value

toEncodingList :: [Option a] -> Encoding

ToJSON a => ToJSON (Identity a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Identity a -> Value

toEncoding :: Identity a -> Encoding

toJSONList :: [Identity a] -> Value

toEncodingList :: [Identity a] -> Encoding

ToJSON a => ToJSON (First a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: First a -> Value

toEncoding :: First a -> Encoding

toJSONList :: [First a] -> Value

toEncodingList :: [First a] -> Encoding

ToJSON a => ToJSON (Last a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Last a -> Value

toEncoding :: Last a -> Encoding

toJSONList :: [Last a] -> Value

toEncodingList :: [Last a] -> Encoding

ToJSON a => ToJSON (Dual a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Dual a -> Value

toEncoding :: Dual a -> Encoding

toJSONList :: [Dual a] -> Value

toEncodingList :: [Dual a] -> Encoding

ToJSON a => ToJSON (NonEmpty a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: NonEmpty a -> Value

toEncoding :: NonEmpty a -> Encoding

toJSONList :: [NonEmpty a] -> Value

toEncodingList :: [NonEmpty a] -> Encoding

ToJSON a => ToJSON (IntMap a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: IntMap a -> Value

toEncoding :: IntMap a -> Encoding

toJSONList :: [IntMap a] -> Value

toEncodingList :: [IntMap a] -> Encoding

ToJSON v => ToJSON (Tree v)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Tree v -> Value

toEncoding :: Tree v -> Encoding

toJSONList :: [Tree v] -> Value

toEncodingList :: [Tree v] -> Encoding

ToJSON a => ToJSON (Seq a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Seq a -> Value

toEncoding :: Seq a -> Encoding

toJSONList :: [Seq a] -> Value

toEncodingList :: [Seq a] -> Encoding

ToJSON a => ToJSON (Set a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Set a -> Value

toEncoding :: Set a -> Encoding

toJSONList :: [Set a] -> Value

toEncodingList :: [Set a] -> Encoding

ToJSON1 f => ToJSON (Fix f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Fix f -> Value

toEncoding :: Fix f -> Encoding

toJSONList :: [Fix f] -> Value

toEncodingList :: [Fix f] -> Encoding

(ToJSON1 f, Functor f) => ToJSON (Mu f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Mu f -> Value

toEncoding :: Mu f -> Encoding

toJSONList :: [Mu f] -> Value

toEncodingList :: [Mu f] -> Encoding

(ToJSON1 f, Functor f) => ToJSON (Nu f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Nu f -> Value

toEncoding :: Nu f -> Encoding

toJSONList :: [Nu f] -> Value

toEncodingList :: [Nu f] -> Encoding

ToJSON a => ToJSON (DNonEmpty a)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: DNonEmpty a -> Value

toEncoding :: DNonEmpty a -> Encoding

toJSONList :: [DNonEmpty a] -> Value

toEncodingList :: [DNonEmpty a] -> Encoding

ToJSON a => ToJSON (DList a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: DList a -> Value

toEncoding :: DList a -> Encoding

toJSONList :: [DList a] -> Value

toEncodingList :: [DList a] -> Encoding

(Prim a, ToJSON a) => ToJSON (Vector a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Vector a -> Value

toEncoding :: Vector a -> Encoding

toJSONList :: [Vector a] -> Value

toEncodingList :: [Vector a] -> Encoding

(Storable a, ToJSON a) => ToJSON (Vector a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Vector a -> Value

toEncoding :: Vector a -> Encoding

toJSONList :: [Vector a] -> Value

toEncodingList :: [Vector a] -> Encoding

(Vector Vector a, ToJSON a) => ToJSON (Vector a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Vector a -> Value

toEncoding :: Vector a -> Encoding

toJSONList :: [Vector a] -> Value

toEncodingList :: [Vector a] -> Encoding

ToJSON a => ToJSON (HashSet a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: HashSet a -> Value

toEncoding :: HashSet a -> Encoding

toJSONList :: [HashSet a] -> Value

toEncodingList :: [HashSet a] -> Encoding

ToJSON a => ToJSON (Vector a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Vector a -> Value

toEncoding :: Vector a -> Encoding

toJSONList :: [Vector a] -> Value

toEncodingList :: [Vector a] -> Encoding

(Prim a, ToJSON a) => ToJSON (PrimArray a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: PrimArray a -> Value

toEncoding :: PrimArray a -> Encoding

toJSONList :: [PrimArray a] -> Value

toEncodingList :: [PrimArray a] -> Encoding

ToJSON a => ToJSON (SmallArray a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: SmallArray a -> Value

toEncoding :: SmallArray a -> Encoding

toJSONList :: [SmallArray a] -> Value

toEncodingList :: [SmallArray a] -> Encoding

ToJSON a => ToJSON (Array a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Array a -> Value

toEncoding :: Array a -> Encoding

toJSONList :: [Array a] -> Value

toEncodingList :: [Array a] -> Encoding

ToJSON a => ToJSON (Maybe a)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Maybe a -> Value

toEncoding :: Maybe a -> Encoding

toJSONList :: [Maybe a] -> Value

toEncodingList :: [Maybe a] -> Encoding

ToJSON a => ToJSON (OpenAIList a)

Defined in OpenAI.Resources

Methods

toJSON :: OpenAIList a -> Value

toEncoding :: OpenAIList a -> Encoding

toJSONList :: [OpenAIList a] -> Value

toEncodingList :: [OpenAIList a] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (Either a b)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Either a b -> Value

toEncoding :: Either a b -> Encoding

toJSONList :: [Either a b] -> Value

toEncodingList :: [Either a b] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (a, b)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b) -> Value

toEncoding :: (a, b) -> Encoding

toJSONList :: [(a, b)] -> Value

toEncodingList :: [(a, b)] -> Encoding

(ToJSON v, ToJSONKey k) => ToJSON (HashMap k v)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: HashMap k v -> Value

toEncoding :: HashMap k v -> Encoding

toJSONList :: [HashMap k v] -> Value

toEncodingList :: [HashMap k v] -> Encoding

(ToJSON v, ToJSONKey k) => ToJSON (Map k v)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Map k v -> Value

toEncoding :: Map k v -> Encoding

toJSONList :: [Map k v] -> Value

toEncodingList :: [Map k v] -> Encoding

HasResolution a => ToJSON (Fixed a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Fixed a -> Value

toEncoding :: Fixed a -> Encoding

toJSONList :: [Fixed a] -> Value

toEncodingList :: [Fixed a] -> Encoding

ToJSON (Proxy a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Proxy a -> Value

toEncoding :: Proxy a -> Encoding

toJSONList :: [Proxy a] -> Value

toEncodingList :: [Proxy a] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (Pair a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Pair a b -> Value

toEncoding :: Pair a b -> Encoding

toJSONList :: [Pair a b] -> Value

toEncodingList :: [Pair a b] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (These a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: These a b -> Value

toEncoding :: These a b -> Encoding

toJSONList :: [These a b] -> Value

toEncodingList :: [These a b] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (Either a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Either a b -> Value

toEncoding :: Either a b -> Encoding

toJSONList :: [Either a b] -> Value

toEncodingList :: [Either a b] -> Encoding

(ToJSON a, ToJSON b) => ToJSON (These a b)

Since: aeson-1.5.1.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: These a b -> Value

toEncoding :: These a b -> Encoding

toJSONList :: [These a b] -> Value

toEncodingList :: [These a b] -> Encoding

(ToJSON a, ToJSON b, ToJSON c) => ToJSON (a, b, c)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c) -> Value

toEncoding :: (a, b, c) -> Encoding

toJSONList :: [(a, b, c)] -> Value

toEncodingList :: [(a, b, c)] -> Encoding

ToJSON a => ToJSON (Const a b)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Const a b -> Value

toEncoding :: Const a b -> Encoding

toJSONList :: [Const a b] -> Value

toEncodingList :: [Const a b] -> Encoding

ToJSON b => ToJSON (Tagged a b)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Tagged a b -> Value

toEncoding :: Tagged a b -> Encoding

toJSONList :: [Tagged a b] -> Value

toEncodingList :: [Tagged a b] -> Encoding

(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (These1 f g a)

Since: aeson-1.5.1.0

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: These1 f g a -> Value

toEncoding :: These1 f g a -> Encoding

toJSONList :: [These1 f g a] -> Value

toEncodingList :: [These1 f g a] -> Encoding

(ToJSON a, ToJSON b, ToJSON c, ToJSON d) => ToJSON (a, b, c, d)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d) -> Value

toEncoding :: (a, b, c, d) -> Encoding

toJSONList :: [(a, b, c, d)] -> Value

toEncodingList :: [(a, b, c, d)] -> Encoding

(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Product f g a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Product f g a -> Value

toEncoding :: Product f g a -> Encoding

toJSONList :: [Product f g a] -> Value

toEncodingList :: [Product f g a] -> Encoding

(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Sum f g a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Sum f g a -> Value

toEncoding :: Sum f g a -> Encoding

toJSONList :: [Sum f g a] -> Value

toEncodingList :: [Sum f g a] -> Encoding

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e) => ToJSON (a, b, c, d, e)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e) -> Value

toEncoding :: (a, b, c, d, e) -> Encoding

toJSONList :: [(a, b, c, d, e)] -> Value

toEncodingList :: [(a, b, c, d, e)] -> Encoding

(ToJSON1 f, ToJSON1 g, ToJSON a) => ToJSON (Compose f g a)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: Compose f g a -> Value

toEncoding :: Compose f g a -> Encoding

toJSONList :: [Compose f g a] -> Value

toEncodingList :: [Compose f g a] -> Encoding

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f) => ToJSON (a, b, c, d, e, f)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f) -> Value

toEncoding :: (a, b, c, d, e, f) -> Encoding

toJSONList :: [(a, b, c, d, e, f)] -> Value

toEncodingList :: [(a, b, c, d, e, f)] -> Encoding

(ToJSON a, ToJSON b, ToJSON c, ToJSON d, ToJSON e, ToJSON f, ToJSON g) => ToJSON (a, b, c, d, e, f, g)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g) -> Value

toEncoding :: (a, b, c, d, e, f, g) -> Encoding

toJSONList :: [(a, b, c, d, e, f, g)] -> Value

toEncodingList :: [(a, b, c, d, e, f, g)] -> Encoding

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h) -> Value

toEncoding :: (a, b, c, d, e, f, g, h) -> Encoding

toJSONList :: [(a, b, c, d, e, f, g, h)] -> Value

toEncodingList :: [(a, b, c, d, e, f, g, h)] -> Encoding

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

toJSON :: (a, b, c, d, e, f, g, h, i) -> Value

toEncoding :: (a, b, c, d, e, f, g, h, i) -> Encoding

toJSONList :: [(a, b, c, d, e, f, g, h, i)] -> Value

toEncodingList :: [(a, b, c, d, e, f, g, h, i)] -> Encoding

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

(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)

Defined in Data.Aeson.Types.ToJSON

Methods

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

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

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

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

class FromJSON a

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

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

Instances

FromJSON Bool

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Bool

parseJSONList :: Value -> Parser [Bool]

FromJSON Char

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Char

parseJSONList :: Value -> Parser [Char]

FromJSON Double

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Double

parseJSONList :: Value -> Parser [Double]

FromJSON Float

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Float

parseJSONList :: Value -> Parser [Float]

FromJSON Int

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Int

parseJSONList :: Value -> Parser [Int]

FromJSON Int8

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Int8

parseJSONList :: Value -> Parser [Int8]

FromJSON Int16

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Int16

parseJSONList :: Value -> Parser [Int16]

FromJSON Int32

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Int32

parseJSONList :: Value -> Parser [Int32]

FromJSON Int64

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Int64

parseJSONList :: Value -> Parser [Int64]

FromJSON Integer

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.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Integer

parseJSONList :: Value -> Parser [Integer]

FromJSON Natural

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Natural

parseJSONList :: Value -> Parser [Natural]

FromJSON Ordering

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Ordering

parseJSONList :: Value -> Parser [Ordering]

FromJSON Word

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Word

parseJSONList :: Value -> Parser [Word]

FromJSON Word8

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Word8

parseJSONList :: Value -> Parser [Word8]

FromJSON Word16

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Word16

parseJSONList :: Value -> Parser [Word16]

FromJSON Word32

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Word32

parseJSONList :: Value -> Parser [Word32]

FromJSON Word64

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Word64

parseJSONList :: Value -> Parser [Word64]

FromJSON ()

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser ()

parseJSONList :: Value -> Parser [()]

FromJSON Version

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Version

parseJSONList :: Value -> Parser [Version]

FromJSON Scientific

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Scientific

parseJSONList :: Value -> Parser [Scientific]

FromJSON Text

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Text

parseJSONList :: Value -> Parser [Text]

FromJSON UTCTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser UTCTime

parseJSONList :: Value -> Parser [UTCTime]

FromJSON Value

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Value

parseJSONList :: Value -> Parser [Value]

FromJSON DotNetTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser DotNetTime

parseJSONList :: Value -> Parser [DotNetTime]

FromJSON Text

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Text

parseJSONList :: Value -> Parser [Text]

FromJSON Void

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Void

parseJSONList :: Value -> Parser [Void]

FromJSON CTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser CTime

parseJSONList :: Value -> Parser [CTime]

FromJSON IntSet

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser IntSet

parseJSONList :: Value -> Parser [IntSet]

FromJSON ZonedTime

Supported string formats:

YYYY-MM-DD HH:MM Z YYYY-MM-DD HH:MM:SS Z YYYY-MM-DD HH:MM:SS.SSS Z

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.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser ZonedTime

parseJSONList :: Value -> Parser [ZonedTime]

FromJSON LocalTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser LocalTime

parseJSONList :: Value -> Parser [LocalTime]

FromJSON TimeOfDay

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser TimeOfDay

parseJSONList :: Value -> Parser [TimeOfDay]

FromJSON CalendarDiffTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser CalendarDiffTime

parseJSONList :: Value -> Parser [CalendarDiffTime]

FromJSON SystemTime

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser SystemTime

parseJSONList :: Value -> Parser [SystemTime]

FromJSON NominalDiffTime

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.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser NominalDiffTime

parseJSONList :: Value -> Parser [NominalDiffTime]

FromJSON DiffTime

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.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser DiffTime

parseJSONList :: Value -> Parser [DiffTime]

FromJSON DayOfWeek

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser DayOfWeek

parseJSONList :: Value -> Parser [DayOfWeek]

FromJSON Day

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Day

parseJSONList :: Value -> Parser [Day]

FromJSON CalendarDiffDays

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser CalendarDiffDays

parseJSONList :: Value -> Parser [CalendarDiffDays]

FromJSON QuarterOfYear

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser QuarterOfYear

parseJSONList :: Value -> Parser [QuarterOfYear]

FromJSON Quarter

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Quarter

parseJSONList :: Value -> Parser [Quarter]

FromJSON Month

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser Month

parseJSONList :: Value -> Parser [Month]

FromJSON UUID

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser UUID

parseJSONList :: Value -> Parser [UUID]

FromJSON AnswerResp

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser AnswerResp

parseJSONList :: Value -> Parser [AnswerResp]

FromJSON AnswerReq

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser AnswerReq

parseJSONList :: Value -> Parser [AnswerReq]

FromJSON FileDeleteConfirmation

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser FileDeleteConfirmation

parseJSONList :: Value -> Parser [FileDeleteConfirmation]

FromJSON File

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser File

parseJSONList :: Value -> Parser [File]

FromJSON FileId

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser FileId

parseJSONList :: Value -> Parser [FileId]

FromJSON SearchResultCreate

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser SearchResultCreate

parseJSONList :: Value -> Parser [SearchResultCreate]

FromJSON SearchResult

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser SearchResult

parseJSONList :: Value -> Parser [SearchResult]

FromJSON TextCompletionCreate

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser TextCompletionCreate

parseJSONList :: Value -> Parser [TextCompletionCreate]

FromJSON TextCompletion

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser TextCompletion

parseJSONList :: Value -> Parser [TextCompletion]

FromJSON TextCompletionChoice

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser TextCompletionChoice

parseJSONList :: Value -> Parser [TextCompletionChoice]

FromJSON TextCompletionId

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser TextCompletionId

parseJSONList :: Value -> Parser [TextCompletionId]

FromJSON Engine

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser Engine

parseJSONList :: Value -> Parser [Engine]

FromJSON EngineId

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser EngineId

parseJSONList :: Value -> Parser [EngineId]

FromJSON TimeStamp

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser TimeStamp

parseJSONList :: Value -> Parser [TimeStamp]

FromJSON a => FromJSON [a]

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser [a]

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

FromJSON a => FromJSON (Maybe a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Maybe a)

parseJSONList :: Value -> Parser [Maybe a]

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

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Ratio a)

parseJSONList :: Value -> Parser [Ratio a]

FromJSON a => FromJSON (Min a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Min a)

parseJSONList :: Value -> Parser [Min a]

FromJSON a => FromJSON (Max a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Max a)

parseJSONList :: Value -> Parser [Max a]

FromJSON a => FromJSON (First a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (First a)

parseJSONList :: Value -> Parser [First a]

FromJSON a => FromJSON (Last a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Last a)

parseJSONList :: Value -> Parser [Last a]

FromJSON a => FromJSON (WrappedMonoid a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (WrappedMonoid a)

parseJSONList :: Value -> Parser [WrappedMonoid a]

FromJSON a => FromJSON (Option a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Option a)

parseJSONList :: Value -> Parser [Option a]

FromJSON a => FromJSON (Identity a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Identity a)

parseJSONList :: Value -> Parser [Identity a]

FromJSON a => FromJSON (First a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (First a)

parseJSONList :: Value -> Parser [First a]

FromJSON a => FromJSON (Last a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Last a)

parseJSONList :: Value -> Parser [Last a]

FromJSON a => FromJSON (Dual a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Dual a)

parseJSONList :: Value -> Parser [Dual a]

FromJSON a => FromJSON (NonEmpty a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (NonEmpty a)

parseJSONList :: Value -> Parser [NonEmpty a]

FromJSON a => FromJSON (IntMap a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (IntMap a)

parseJSONList :: Value -> Parser [IntMap a]

FromJSON v => FromJSON (Tree v)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Tree v)

parseJSONList :: Value -> Parser [Tree v]

FromJSON a => FromJSON (Seq a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Seq a)

parseJSONList :: Value -> Parser [Seq a]

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

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Set a)

parseJSONList :: Value -> Parser [Set a]

FromJSON1 f => FromJSON (Fix f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Fix f)

parseJSONList :: Value -> Parser [Fix f]

(FromJSON1 f, Functor f) => FromJSON (Mu f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Mu f)

parseJSONList :: Value -> Parser [Mu f]

(FromJSON1 f, Functor f) => FromJSON (Nu f)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Nu f)

parseJSONList :: Value -> Parser [Nu f]

FromJSON a => FromJSON (DNonEmpty a)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (DNonEmpty a)

parseJSONList :: Value -> Parser [DNonEmpty a]

FromJSON a => FromJSON (DList a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (DList a)

parseJSONList :: Value -> Parser [DList a]

(Prim a, FromJSON a) => FromJSON (Vector a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Vector a)

parseJSONList :: Value -> Parser [Vector a]

(Storable a, FromJSON a) => FromJSON (Vector a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Vector a)

parseJSONList :: Value -> Parser [Vector a]

(Vector Vector a, FromJSON a) => FromJSON (Vector a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Vector a)

parseJSONList :: Value -> Parser [Vector a]

(Eq a, Hashable a, FromJSON a) => FromJSON (HashSet a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (HashSet a)

parseJSONList :: Value -> Parser [HashSet a]

FromJSON a => FromJSON (Vector a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Vector a)

parseJSONList :: Value -> Parser [Vector a]

(Prim a, FromJSON a) => FromJSON (PrimArray a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (PrimArray a)

parseJSONList :: Value -> Parser [PrimArray a]

FromJSON a => FromJSON (SmallArray a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (SmallArray a)

parseJSONList :: Value -> Parser [SmallArray a]

FromJSON a => FromJSON (Array a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Array a)

parseJSONList :: Value -> Parser [Array a]

FromJSON a => FromJSON (Maybe a)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Maybe a)

parseJSONList :: Value -> Parser [Maybe a]

FromJSON a => FromJSON (OpenAIList a)

Defined in OpenAI.Resources

Methods

parseJSON :: Value -> Parser (OpenAIList a)

parseJSONList :: Value -> Parser [OpenAIList a]

(FromJSON a, FromJSON b) => FromJSON (Either a b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Either a b)

parseJSONList :: Value -> Parser [Either a b]

(FromJSON a, FromJSON b) => FromJSON (a, b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b)

parseJSONList :: Value -> Parser [(a, b)]

(FromJSON v, FromJSONKey k, Eq k, Hashable k) => FromJSON (HashMap k v)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (HashMap k v)

parseJSONList :: Value -> Parser [HashMap k v]

(FromJSONKey k, Ord k, FromJSON v) => FromJSON (Map k v)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Map k v)

parseJSONList :: Value -> Parser [Map k v]

HasResolution a => FromJSON (Fixed a)

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.

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Fixed a)

parseJSONList :: Value -> Parser [Fixed a]

FromJSON (Proxy a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Proxy a)

parseJSONList :: Value -> Parser [Proxy a]

(FromJSON a, FromJSON b) => FromJSON (Pair a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Pair a b)

parseJSONList :: Value -> Parser [Pair a b]

(FromJSON a, FromJSON b) => FromJSON (These a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (These a b)

parseJSONList :: Value -> Parser [These a b]

(FromJSON a, FromJSON b) => FromJSON (Either a b)

Since: aeson-1.5.3.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Either a b)

parseJSONList :: Value -> Parser [Either a b]

(FromJSON a, FromJSON b) => FromJSON (These a b)

Since: aeson-1.5.1.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (These a b)

parseJSONList :: Value -> Parser [These a b]

(FromJSON a, FromJSON b, FromJSON c) => FromJSON (a, b, c)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c)

parseJSONList :: Value -> Parser [(a, b, c)]

FromJSON a => FromJSON (Const a b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Const a b)

parseJSONList :: Value -> Parser [Const a b]

FromJSON b => FromJSON (Tagged a b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Tagged a b)

parseJSONList :: Value -> Parser [Tagged a b]

(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (These1 f g a)

Since: aeson-1.5.1.0

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (These1 f g a)

parseJSONList :: Value -> Parser [These1 f g a]

(FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSON (a, b, c, d)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d)

parseJSONList :: Value -> Parser [(a, b, c, d)]

(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Product f g a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Product f g a)

parseJSONList :: Value -> Parser [Product f g a]

(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Sum f g a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Sum f g a)

parseJSONList :: Value -> Parser [Sum f g a]

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e) => FromJSON (a, b, c, d, e)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e)

parseJSONList :: Value -> Parser [(a, b, c, d, e)]

(FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Compose f g a)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (Compose f g a)

parseJSONList :: Value -> Parser [Compose f g a]

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f) => FromJSON (a, b, c, d, e, f)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f)]

(FromJSON a, FromJSON b, FromJSON c, FromJSON d, FromJSON e, FromJSON f, FromJSON g) => FromJSON (a, b, c, d, e, f, g)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g)]

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h)]

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i)]

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j)]

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k)

parseJSONList :: Value -> Parser [(a, b, c, d, e, f, g, h, i, j, k)]

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

parseJSON :: Value -> Parser (a, b, c, d, e, f, g, h, i, j, k, l)

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

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

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

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

(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)

Defined in Data.Aeson.Types.FromJSON

Methods

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

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

(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)

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)

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