Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Registry.Aeson.Encoder

Synopsis

newtype Encoder a = Encoder {
- encode :: a -> (Value, Encoding)
}
newtype ConstructorEncoder = ConstructorEncoder {
- encodeConstructor :: Options -> FromConstructor -> (Value, Encoding)
}
data FromConstructor = FromConstructor {
- fromConstructorNames :: [Text]
- fromConstructorTypes :: [Text]
- fromConstructorName :: Text
- fromConstructorFieldNames :: [Text]
- fromConstructorValues :: [(Value, Encoding)]
}
newtype KeyEncoder a = KeyEncoder {
- encodeAsKey :: a -> Key
}
array :: [Value] -> Value
encodeByteString :: Encoder a -> a -> ByteString
encodeValue :: Encoder a -> a -> Value
encodeKey :: forall a. Typeable a => (a -> Text) -> Typed (KeyEncoder a)
keyEncoder :: (a -> Text) -> KeyEncoder a
fromValue :: (a -> Value) -> Encoder a
jsonEncoder :: forall a. (ToJSON a, Typeable a) => Typed (Encoder a)
jsonEncoderOf :: ToJSON a => Encoder a
encodeMaybeOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Maybe a))
maybeOfEncoder :: Encoder a -> Encoder (Maybe a)
encodePairOf :: forall a b. (Typeable a, Typeable b) => Typed (Encoder a -> Encoder b -> Encoder (a, b))
pairOfEncoder :: Encoder a -> Encoder b -> Encoder (a, b)
encodeTripleOf :: forall a b c. (Typeable a, Typeable b, Typeable c) => Typed (Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c))
tripleOfEncoder :: Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c)
encodeSetOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Set a))
setOfEncoder :: Encoder a -> Encoder (Set a)
encodeListOf :: forall a. Typeable a => Typed (Encoder a -> Encoder [a])
listOfEncoder :: Encoder a -> Encoder [a]
encodeMapOf :: forall a b. (Typeable a, Typeable b) => Typed (KeyEncoder a -> Encoder b -> Encoder (Map a b))
mapOfEncoder :: KeyEncoder a -> Encoder b -> Encoder (Map a b)
encodeNonEmptyOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (NonEmpty a))
nonEmptyOfEncoder :: Encoder a -> Encoder (NonEmpty a)
defaultEncoderOptions :: Registry _ _
defaultConstructorEncoder :: ConstructorEncoder
textKeyEncoder :: KeyEncoder Text
stringKeyEncoder :: KeyEncoder String
makeEncoderFromConstructor :: Options -> FromConstructor -> (Value, Encoding)
modifyFromConstructorWithOptions :: Options -> FromConstructor -> FromConstructor
makeSumEncoding :: Options -> FromConstructor -> (Value, Encoding)
valuesToObject :: [Text] -> [(Value, Encoding)] -> (Value, Encoding)
module Data.Registry.Aeson.TH.Encoder
module Data.Registry.Aeson.TH.ThOptions

Documentation

newtype Encoder a Source #

Constructors

Encoder
Fields encode :: a -> (Value, Encoding)

Instances

Instances details

Contravariant Encoder Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods contramap :: (a' -> a) -> Encoder a -> Encoder a' # (>$) :: b -> Encoder b -> Encoder a #

newtype ConstructorEncoder Source #

A ConstructorEncoder uses configuration options + type information extracted from a given data type (with TemplateHaskell) in order to produce a Value and an Encoding

Constructors

ConstructorEncoder
Fields encodeConstructor :: Options -> FromConstructor -> (Value, Encoding)

data FromConstructor Source #

Minimum set of data extracted from a given type with Template Haskell in order to create the appropriate encoder given an Options value

Constructors

FromConstructor
Fields fromConstructorNames :: [Text] names of all the constructors of the type fromConstructorTypes :: [Text] types of all the constructors of the type fromConstructorName :: Text name of the constructor for the value to encode fromConstructorFieldNames :: [Text] name of all the constructor fields fromConstructorValues :: [(Value, Encoding)] encoded values of all the constructor fields

Instances

Instances details

Show FromConstructor Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods showsPrec :: Int -> FromConstructor -> ShowS # show :: FromConstructor -> String # showList :: [FromConstructor] -> ShowS #
Eq FromConstructor Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods (==) :: FromConstructor -> FromConstructor -> Bool # (/=) :: FromConstructor -> FromConstructor -> Bool #

newtype KeyEncoder a Source #

Constructors

KeyEncoder
Fields encodeAsKey :: a -> Key

Instances

Instances details

Contravariant KeyEncoder Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods contramap :: (a' -> a) -> KeyEncoder a -> KeyEncoder a' # (>$) :: b -> KeyEncoder b -> KeyEncoder a #

array :: [Value] -> Value Source #

Shortcut function to create arrays

encodeByteString :: Encoder a -> a -> ByteString Source #

encodeValue :: Encoder a -> a -> Value Source #

encodeKey :: forall a. Typeable a => (a -> Text) -> Typed (KeyEncoder a) Source #

Make a key encoder from a function returning some text

keyEncoder :: (a -> Text) -> KeyEncoder a Source #

fromValue :: (a -> Value) -> Encoder a Source #

Create an Encoder from a function returning a Value

jsonEncoder :: forall a. (ToJSON a, Typeable a) => Typed (Encoder a) Source #

Create an encoder from a Aeson instance

jsonEncoderOf :: ToJSON a => Encoder a Source #

encodeMaybeOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Maybe a)) Source #

Create an Encoder for a (Maybe a)

maybeOfEncoder :: Encoder a -> Encoder (Maybe a) Source #

encodePairOf :: forall a b. (Typeable a, Typeable b) => Typed (Encoder a -> Encoder b -> Encoder (a, b)) Source #

Create an Encoder for a pair (a, b)

pairOfEncoder :: Encoder a -> Encoder b -> Encoder (a, b) Source #

encodeTripleOf :: forall a b c. (Typeable a, Typeable b, Typeable c) => Typed (Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c)) Source #

Create an Encoder for a tripe (a, b, c)

tripleOfEncoder :: Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c) Source #

encodeSetOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Set a)) Source #

Create an Encoder for a Set a

setOfEncoder :: Encoder a -> Encoder (Set a) Source #

encodeListOf :: forall a. Typeable a => Typed (Encoder a -> Encoder [a]) Source #

Create an Encoder for a list [a]

listOfEncoder :: Encoder a -> Encoder [a] Source #

encodeMapOf :: forall a b. (Typeable a, Typeable b) => Typed (KeyEncoder a -> Encoder b -> Encoder (Map a b)) Source #

Create an Encoder for a map a b

mapOfEncoder :: KeyEncoder a -> Encoder b -> Encoder (Map a b) Source #

encodeNonEmptyOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (NonEmpty a)) Source #

Create an Encoder for a non-empty list (NonEmpty a)

nonEmptyOfEncoder :: Encoder a -> Encoder (NonEmpty a) Source #

defaultEncoderOptions :: Registry _ _ Source #

defaultConstructorEncoder :: ConstructorEncoder Source #

Default implementation, it can be overridden in a registry

textKeyEncoder :: KeyEncoder Text Source #

stringKeyEncoder :: KeyEncoder String Source #

makeEncoderFromConstructor :: Options -> FromConstructor -> (Value, Encoding) Source #

Make an Encoder from Options and the representation of a constructor for a given value to encode

modifyFromConstructorWithOptions :: Options -> FromConstructor -> FromConstructor Source #

Apply Options to the constructor name + field names and remove Nothing values if necessary

makeSumEncoding :: Options -> FromConstructor -> (Value, Encoding) Source #

valuesToObject :: [Text] -> [(Value, Encoding)] -> (Value, Encoding) Source #

Create an Object from a list of field names and a list of Values both as a Value and as an Encoding

module Data.Registry.Aeson.TH.Encoder

module Data.Registry.Aeson.TH.ThOptions