Data.Aeson.Deriving.Known

Documentation

data Null

Represents the null JSON Value.

Instances

KnownJSON Null

Defined in Data.Aeson.Deriving.Known

Methods

jsonVal :: Proxy Null -> Value

data field := (value :: k) infix 3

Phantom data type to make explicit which fields we pass for Aeson options. Polykinded in the second argument so it can take i.e. Booleans or Symbols where needed.

Also used for specifying constant values added to, or required from, an encoding. See Data.Aeson.Deriving.WithConstantFields.

Instances

(All (StringFunction :: k2 -> Constraint) (fieldLabelModifier ': (constructorTagModifier ': ([] :: [k2]))), ToSumEncoding sumEncoding, All KnownBool (allNullaryToStringTag ': (omitNothingFields ': (unwrapUnaryRecords ': (tagSingleConstructors ': ([] :: [Bool])))))) => ToAesonOptions (GenericOptions (FieldLabelModifier := fieldLabelModifier) (ConstructorTagModifier := constructorTagModifier) (AllNullaryToStringTag := allNullaryToStringTag) (OmitNothingFields := omitNothingFields) (SumEncoding := sumEncoding) (UnwrapUnaryRecords := unwrapUnaryRecords) (TagSingleConstructors := tagSingleConstructors) :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptions :: Proxy (GenericOptions (FieldLabelModifier := fieldLabelModifier) (ConstructorTagModifier := constructorTagModifier) (AllNullaryToStringTag := allNullaryToStringTag) (OmitNothingFields := omitNothingFields) (SumEncoding := sumEncoding) (UnwrapUnaryRecords := unwrapUnaryRecords) (TagSingleConstructors := tagSingleConstructors)) -> Options

(KnownJSONObject fields, KnownSymbol key, KnownJSON val) => KnownJSONObject ((key := val) ': fields :: [Type])

Defined in Data.Aeson.Deriving.Known

Methods

objectVal :: Proxy ((key := val) ': fields) -> Object

KnownBool b => ToAesonOptionsField (TagSingleConstructors := b :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (TagSingleConstructors := b) -> Options -> Options

KnownBool b => ToAesonOptionsField (UnwrapUnaryRecords := b :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (UnwrapUnaryRecords := b) -> Options -> Options

KnownBool b => ToAesonOptionsField (OmitNothingFields := b :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (OmitNothingFields := b) -> Options -> Options

KnownBool b => ToAesonOptionsField (AllNullaryToStringTag := b :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (AllNullaryToStringTag := b) -> Options -> Options

StringFunction f => ToAesonOptionsField (ConstructorTagModifier := f :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (ConstructorTagModifier := f) -> Options -> Options

StringFunction f => ToAesonOptionsField (FieldLabelModifier := f :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (FieldLabelModifier := f) -> Options -> Options

ToSumEncoding se => ToAesonOptionsField (SumEncoding := se :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

toAesonOptionsField :: Proxy (SumEncoding := se) -> Options -> Options

data a ==> b infix 6

Represents a function that maps the first value to the second, and otherwise does nothing but return the input.

Instances

All KnownSymbol (a ': (b ': ([] :: [Symbol]))) => StringFunction (a ==> b :: Type)

Defined in Data.Aeson.Deriving.Internal.Generic

Methods

stringFunction :: Proxy (a ==> b) -> String -> String

(KnownJSON a, KnownJSON b) => KnownJSONFunction (a ==> b)

Defined in Data.Aeson.Deriving.Known

Methods

functionVal :: Proxy (a ==> b) -> Value -> Value

data WithDefault (val :: k)

Represents the function that turns nulls into the given default value.

Instances

KnownJSON a => KnownJSONFunction (WithDefault a)

Defined in Data.Aeson.Deriving.Known

Methods

functionVal :: Proxy (WithDefault a) -> Value -> Value

class KnownJSON (a :: k) where

Constant JSON values

Methods

jsonVal :: Proxy a -> Value

Instances

KnownBool b => KnownJSON (b :: Bool)

Defined in Data.Aeson.Deriving.Known

Methods

jsonVal :: Proxy b -> Value

KnownSymbol str => KnownJSON (str :: Symbol)

Defined in Data.Aeson.Deriving.Known

Methods

jsonVal :: Proxy str -> Value

KnownJSONList xs => KnownJSON (xs :: [k])

Defined in Data.Aeson.Deriving.Known

Methods

jsonVal :: Proxy xs -> Value

KnownJSON Null

Defined in Data.Aeson.Deriving.Known

Methods

jsonVal :: Proxy Null -> Value

class KnownBool (b :: Bool) where

Constant boolean values

Methods

boolVal :: Proxy b -> Bool

Instances

KnownBool False

Defined in Data.Aeson.Deriving.Known

Methods

boolVal :: Proxy False -> Bool

KnownBool True

Defined in Data.Aeson.Deriving.Known

Methods

boolVal :: Proxy True -> Bool

class KnownJSONList (xs :: [k]) where

Constant JSON lists

Methods

listVal :: Proxy xs -> [Value]

Instances

KnownJSONList ([] :: [k])

Defined in Data.Aeson.Deriving.Known

Methods

listVal :: Proxy [] -> [Value]

(KnownJSON x, KnownJSONList xs) => KnownJSONList (x ': xs :: [k])

Defined in Data.Aeson.Deriving.Known

Methods

listVal :: Proxy (x ': xs) -> [Value]

class KnownJSONObject (a :: k) where

Constant JSON objects

Methods

objectVal :: Proxy a -> Object

Instances

KnownJSONObject ([] :: [k])

Defined in Data.Aeson.Deriving.Known

Methods

objectVal :: Proxy [] -> Object

(KnownJSONObject fields, KnownSymbol key, KnownJSON val) => KnownJSONObject ((key := val) ': fields :: [Type])

Defined in Data.Aeson.Deriving.Known

Methods

objectVal :: Proxy ((key := val) ': fields) -> Object

class KnownJSONFunction (a :: Type) where

JSON (Value) functions

Methods

functionVal :: Proxy a -> Value -> Value

Instances

KnownJSON a => KnownJSONFunction (WithDefault a)

Defined in Data.Aeson.Deriving.Known

Methods

functionVal :: Proxy (WithDefault a) -> Value -> Value

(KnownJSON a, KnownJSON b) => KnownJSONFunction (a ==> b)

Defined in Data.Aeson.Deriving.Known

Methods

functionVal :: Proxy (a ==> b) -> Value -> Value