Safe Haskell	None
Language	Haskell2010

Data.Aeson.Encoding

Contents

Encoding
Predicates
Encoding constructors

Description

Functions in this module return well-formed Encoding'. Polymorphic variants, which return Encoding a, return a textual JSON value, so it can be used as both Encoding' Text and Encoding = Encoding' Value.

Synopsis

Encoding

type Encoding = Encoding' Value #

Often used synonnym for Encoding'.

data Encoding' tag #

An encoding of a JSON value.

tag represents which kind of JSON the Encoding is encoding to, we reuse Text and Value as tags here.

Instances

Eq (Encoding' a) #
Methods (==) :: Encoding' a -> Encoding' a -> Bool # (/=) :: Encoding' a -> Encoding' a -> Bool #
Ord (Encoding' a) #
Methods compare :: Encoding' a -> Encoding' a -> Ordering # (<) :: Encoding' a -> Encoding' a -> Bool # (<=) :: Encoding' a -> Encoding' a -> Bool # (>) :: Encoding' a -> Encoding' a -> Bool # (>=) :: Encoding' a -> Encoding' a -> Bool # max :: Encoding' a -> Encoding' a -> Encoding' a # min :: Encoding' a -> Encoding' a -> Encoding' a #
Show (Encoding' a) #
Methods showsPrec :: Int -> Encoding' a -> ShowS # show :: Encoding' a -> String # showList :: [Encoding' a] -> ShowS #

encodingToLazyByteString :: Encoding' a -> ByteString #

fromEncoding :: Encoding' tag -> Builder #

Acquire the underlying bytestring builder.

unsafeToEncoding :: Builder -> Encoding' a #

Make Encoding from Builder.

Use with care! You have to make sure that the passed Builder is a valid JSON Encoding!

data Series #

A series of values that, when encoded, should be separated by commas. Since 0.11.0.0, the .= operator is overloaded to create either (Text, Value) or Series. You can use Series when encoding directly to a bytestring builder as in the following example:

toEncoding (Person name age) = pairs ("name" .= name <> "age" .= age)

Instances

Semigroup Series #
Methods (<>) :: Series -> Series -> Series # sconcat :: NonEmpty Series -> Series # stimes :: Integral b => b -> Series -> Series #
Monoid Series #
Methods mempty :: Series # mappend :: Series -> Series -> Series # mconcat :: [Series] -> Series #
KeyValue Series #
Methods (.=) :: ToJSON v => Text -> v -> Series #

pairs :: Series -> Encoding #

Encode a series of key/value pairs, separated by commas.

pair :: Text -> Encoding -> Series #

Predicates

nullEncoding :: Encoding' a -> Bool #

Encoding constructors

emptyArray_ :: Encoding #

emptyObject_ :: Encoding #

text :: Text -> Encoding' a #

lazyText :: Text -> Encoding' a #

string :: String -> Encoding' a #

list :: (a -> Encoding) -> [a] -> Encoding #

dict #

Arguments

:: (k -> Encoding' Text)	key encoding
-> (v -> Encoding)	value encoding
-> (forall a. (k -> v -> a -> a) -> a -> m -> a)	`foldrWithKey` - indexed fold
-> m	container
-> Encoding