As a convenience, this type defines the i to be a specific Json structure:

As a convenience, this type is a pure Encoder over Identity in place of the f.

As a convenience, this type defines the i to be a specific 'JObject WS Json' structure:

As a convenience, this type is a pure ObjEncoder over Identity in place of the f.

Create an Encoder' for a by providing a function from 'a -> f Json'.

As encodeA but specialised to Identity when the additional flexibility isn't needed.

Helper function for creating an Encoder, provides the default finaliseEncoding function for Json encoders.

Helper function for creating a JSON object Encoder. Provides the default finaliseEncoding function for completing the JObject to the necessary Json type.

Run any encoder to the Json representation, with the context specialised to Identity for convenience.

Run any encoder to the Json representation, allowing for some Functor context f.

Encode an a directly to some output text type using the provided Builder and Encoder.

Encode an a directly to a Text using the provided Encoder.

Encode an a directly to a Text using the provided Encoder.

Encode an a directly to a Text using the provided Encoder.

Encode an a directly to a ByteString using the provided Encoder.

Encode an a directly to a ByteString using the provided Encoder.

As per simpleEncodeText but specialised the f to Identity.

As per simpleEncodeTextNoSpaces but specialised the f to Identity.

As per simpleEncodeByteString but specialised the f to Identity.

As per simpleEncodeByteStringNoSpaces but specialised the f to Identity.

Encode an Int

Encode a numeric value of the typeclass Integral

Encode an Scientific

Encode a Bool

Encode a String

Encode a Text

Encode an explicit null.

Encode an Either value using the given Encoders

Encode a Maybe value, using the provided Encoder's to handle the different choices.

Encode a 'Maybe a' to either 'Encoder a' or null

Encode some Traversable of a into a JSON array.

Encode a list

Encode a NonEmpty list

Encode a Map in a JSON object.

Encoder' for a Waargonaut Json data structure

Build an Encoder using a Prism'

Transform the given input using the Encoder to its Json data structure representation.

Apply a function to update a MapLikeObj and encode that as a JSON object.

For example, given the following data type:

data Image = Image
  { _imageW        :: Int
  , _imageH        :: Int
  , _imageTitle    :: Text
  , _imageAnimated :: Bool
  , _imageIDs      :: [Int]
  }

We can use this function to create an encoder, composing the individual update functions to set the keys and values as desired.

encodeImage :: Applicative f => Encoder f Image
encodeImage = mapLikeObj $ \img ->
  intAt "Width" (_imageW img) .           -- ^ Set an Int value at the "Width" key.
  intAt "Height" (_imageH img) .
  textAt "Title" (_imageTitle img) .
  boolAt "Animated" (_imageAnimated img) .
  listAt int "IDs" (_imageIDs img) -- ^ Set an [Int] value at the "IDs" key.

When encoding a MapLikeObj, this function lets you encode a value at a specific key

Optionally encode an a if it is a Just a. A Nothing will result in the key being absent from the object.

Encode an Int at the given Text key.

Encode a Text value at the given Text key.

Encode a Bool at the given Text key.

Encode a Foldable of a at the given index on a JSON object.

Encode a standard Haskell list at the given index on a JSON object.

Encode a NonEmpty list at the given index on a JSON object.

Using a given Encoder, encode a key value pair on the JSON object, using the accessor function to retrieve the value.

Encode key value pairs as a JSON object, allowing duplicate keys.

When encoding a JSON object that may contain duplicate keys, this function works the same as the atKey function for MapLikeObj.

Encode some Foldable of (Text, a) as a JSON object. This permits duplicate keys.

This function allows you to extend the fields on a JSON object created by a separate encoder.

This function lets you extend the fields on a JSON object but enforces the uniqueness of the keys by working through the MapLikeObj structure.

This will keep the first occurence of each unique key in the map. So be sure to check your output.

Given encoders for things that are represented in JSON as objects, and a way to get to the b and c from the a. This function lets you create an encoder for a. The two objects are combined to make one single JSON object.

Given

encodeFoo :: ObjEncoder f Foo
encodeBar :: ObjEncoder f Bar
-- and some wrapping type:
data A = { _foo :: Foo, _bar :: Bar }

We can use this function to utilise our already defined ObjEncoder structures to give us an encoder for A:

combineObjects (aRecord -> (_foo aRecord, _bar aRecord)) encodeFoo encodeBar :: ObjEncoder f Bar

As per int but with the f specialised to Identity.

As per integral but with the f specialised to Identity.

As per scientific but with the f specialised to Identity.

As per bool but with the f specialised to Identity.

As per string but with the f specialised to Identity.

As per text but with the f specialised to Identity.

As per null but with the f specialised to Identity.

As per either but with the f specialised to Identity.

As per maybe but with the f specialised to Identity.

As per maybeOrNull but with the f specialised to Identity.

As per traversable but with the f specialised to Identity.

As per nonempty but with the f specialised to Identity.

As per list but with the f specialised to Identity.

Encode an a at the given index on the JSON object.

Optionally encode a key : value pair on an object.

encoder = E.mapLikeObj $ \a ->
  atKey' "A" E.text (_getterA a)
  atOptKey' "B" E.int (_maybeB a)

simplePureEncodeByteString encoder (Foo "bob" (Just 33)) = "{"A":"bob","B":33}"

simplePureEncodeByteString encoder (Foo "bob" Nothing) = "{"A":"bob"}"

As per mapLikeObj but specialised for Identity as the Applicative.

Using the given function to convert the k type keys to a Text value, encode a Map as a JSON object.

As per keyValuesAsObj but with the f specialised to Identity.

As per json but with the f specialised to Identity.

As per asJson, but with the Encoder specialised to Identity

As per onObj but the f is specialised to Identity.

Generalise any Encoder a' to 'Encoder f a'