Safe Haskell	None
Language	Haskell2010

Data.Aeson.Deriving.Internal.Generic

Synopsis

class ToAesonOptions a where
- toAesonOptions :: Proxy a -> Options
type ToAesonOptionsListError = ((((((((((((((Text "aeson-deriving constraint error for ToAesonOptions class:" :$$: Text "Don't forget to \"tick\" your opening list bracket.") :$$: Text "There is no ToAesonOptions instance for list types.") :$$: Text "Rather, there are instances for promoted list values.") :$$: Text "") :$$: Text "You likely should correct your deriving declaration to something like:") :$$: Text "") :$$: Text " via GenericEncoded '[myVal1,..]") :$$: Text "") :$$: Text "Instead of:") :$$: Text "") :$$: Text " via GenericEncoded [myVal1,..]") :$$: Text "") :$$: Text "For explanation, see GHC documentation on datatype promotion:") :$$: Text "https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/glasgow_exts.html#datatype-promotion") :$$: Text ""
class ToAesonOptionsField x where
- toAesonOptionsField :: Proxy x -> Options -> Options
data FieldLabelModifier
data ConstructorTagModifier
data AllNullaryToStringTag
data OmitNothingFields
data UnwrapUnaryRecords
data TagSingleConstructors
data GenericOptions :: fieldLabelModifier -> constructorTagModifier -> allNullaryToStringTag -> omitNothingFields -> sumEncoding -> unwrapUnaryRecords -> tagSingleConstructors -> Type
newtype GenericEncoded opts a = GenericEncoded a
type family LoopWarning (n :: Type -> Type) (a :: Type) :: Constraint where ...
newtype DisableLoopWarning a = DisableLoopWarning a
newtype RecordSumEncoded (tagKey :: Symbol) (tagModifier :: k) (a :: Type) = RecordSumEncoded a
stripSuffix :: Eq a => [a] -> [a] -> Maybe [a]
dropPrefix :: Eq a => [a] -> [a] -> [a]
dropSuffix :: Eq a => [a] -> [a] -> [a]
class StringFunction (a :: k) where
- stringFunction :: Proxy a -> String -> String
data Id
data SnakeCase
data Uppercase
data Lowercase
data FirstChar a
data DropLowercasePrefix
data DropPrefix (str :: Symbol)
data DropSuffix (str :: Symbol)
class ToSumEncoding a where
- toSumEncoding :: Proxy a -> SumEncoding
data UntaggedValue
data ObjectWithSingleField
data TwoElemArray
data TaggedObject (tagFieldName :: Symbol) (contentsFieldName :: Symbol)
snakeCase :: String -> String
dropLowercasePrefix :: String -> String
newtype x & f = Ampersand {
- unAmpersand :: f x
}

Documentation

class ToAesonOptions a where Source #

A class for defining Options for Aeson's Generic deriving support. It is generally instantiated by overriding specific fields using the instance for (type-level) list values. It can also be instantiated in a more exhaustive way using the GenericOptions type. In both cases fields are specified in a record-like form using the '(:=)' data type for explicitness.

See the ReadMe or tests for examples.

Users may also provide instances for their own phantom data types if desired.

Methods

toAesonOptions :: Proxy a -> Options Source #

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) Source #
Instance details 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 Source #
ToAesonOptions ([] :: [k]) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptions :: Proxy [] -> Options Source #
(TypeError ToAesonOptionsListError :: Constraint) => ToAesonOptions ([a] :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptions :: Proxy [a] -> Options Source #
(ToAesonOptionsField x, ToAesonOptions xs) => ToAesonOptions (x ': xs :: [a]) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptions :: Proxy (x ': xs) -> Options Source #
(TypeError ToAesonOptionsListError :: Constraint) => ToAesonOptions [] Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptions :: Proxy [] -> Options Source #

type ToAesonOptionsListError = ((((((((((((((Text "aeson-deriving constraint error for ToAesonOptions class:" :$$: Text "Don't forget to \"tick\" your opening list bracket.") :$$: Text "There is no ToAesonOptions instance for list types.") :$$: Text "Rather, there are instances for promoted list values.") :$$: Text "") :$$: Text "You likely should correct your deriving declaration to something like:") :$$: Text "") :$$: Text " via GenericEncoded '[myVal1,..]") :$$: Text "") :$$: Text "Instead of:") :$$: Text "") :$$: Text " via GenericEncoded [myVal1,..]") :$$: Text "") :$$: Text "For explanation, see GHC documentation on datatype promotion:") :$$: Text "https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/glasgow_exts.html#datatype-promotion") :$$: Text "" Source #

class ToAesonOptionsField x where Source #

A class that knows about fields of aeson's Options.

Methods

toAesonOptionsField :: Proxy x -> Options -> Options Source #

Instances

KnownBool b => ToAesonOptionsField (TagSingleConstructors := b :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (TagSingleConstructors := b) -> Options -> Options Source #
KnownBool b => ToAesonOptionsField (UnwrapUnaryRecords := b :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (UnwrapUnaryRecords := b) -> Options -> Options Source #
KnownBool b => ToAesonOptionsField (OmitNothingFields := b :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (OmitNothingFields := b) -> Options -> Options Source #
KnownBool b => ToAesonOptionsField (AllNullaryToStringTag := b :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (AllNullaryToStringTag := b) -> Options -> Options Source #
StringFunction f => ToAesonOptionsField (ConstructorTagModifier := f :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (ConstructorTagModifier := f) -> Options -> Options Source #
StringFunction f => ToAesonOptionsField (FieldLabelModifier := f :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (FieldLabelModifier := f) -> Options -> Options Source #
ToSumEncoding se => ToAesonOptionsField (SumEncoding := se :: Type) Source #
Instance details Defined in Data.Aeson.Deriving.Internal.Generic Methods toAesonOptionsField :: Proxy (SumEncoding := se) -> Options -> Options Source #

data FieldLabelModifier Source #