Data.Aeson.Encoding

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.

Encoding

type Encoding = Encoding' Value

Often used synonym 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 Series as tags here.

Instances

KeyValue Encoding Series

Defined in Data.Aeson.Types.ToJSON

Methods

(.=) :: ToJSON v => Key -> v -> Series

explicitToField :: (v -> Encoding) -> Key -> v -> Series

KeyValueOmit Encoding Series

Defined in Data.Aeson.Types.ToJSON

Methods

(.?=) :: ToJSON v => Key -> v -> Series

explicitToFieldOmit :: (v -> Bool) -> (v -> Encoding) -> Key -> v -> Series

GToJSON' Encoding arity (U1 :: TYPE LiftedRep -> Type)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding arity a -> U1 a -> Encoding

GToJSON' Encoding arity (V1 :: TYPE LiftedRep -> Type)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding arity a -> V1 a -> Encoding

ToJSON1 f => GToJSON' Encoding One (Rec1 f)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding One a -> Rec1 f a -> Encoding

(EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding arity a0 -> (a :*: b) a0 -> Encoding

ToJSON a => GToJSON' Encoding arity (K1 i a :: TYPE LiftedRep -> Type)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding arity a0 -> K1 i a a0 -> Encoding

(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding One a -> (f :.: g) a -> Encoding

IsString (Encoding' a)

Since: 2.2.0.0

Defined in Data.Aeson.Encoding.Internal

Methods

fromString :: String -> Encoding' a

Show (Encoding' a)

Defined in Data.Aeson.Encoding.Internal

Methods

showsPrec :: Int -> Encoding' a -> ShowS

show :: Encoding' a -> String

showList :: [Encoding' a] -> ShowS

Eq (Encoding' a)

Defined in Data.Aeson.Encoding.Internal

Methods

(==) :: Encoding' a -> Encoding' a -> Bool

(/=) :: Encoding' a -> Encoding' a -> Bool

Ord (Encoding' a)

Defined in Data.Aeson.Encoding.Internal

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

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

Monoid Series

Defined in Data.Aeson.Encoding.Internal

Methods

mempty :: Series

mappend :: Series -> Series -> Series

mconcat :: [Series] -> Series

Semigroup Series

Defined in Data.Aeson.Encoding.Internal

Methods

(<>) :: Series -> Series -> Series

sconcat :: NonEmpty Series -> Series

stimes :: Integral b => b -> Series -> Series

KeyValue Encoding Series

Defined in Data.Aeson.Types.ToJSON

Methods

(.=) :: ToJSON v => Key -> v -> Series

explicitToField :: (v -> Encoding) -> Key -> v -> Series

KeyValueOmit Encoding Series

Defined in Data.Aeson.Types.ToJSON

Methods

(.?=) :: ToJSON v => Key -> v -> Series

explicitToFieldOmit :: (v -> Bool) -> (v -> Encoding) -> Key -> v -> Series

pairs :: Series -> Encoding

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

pair :: Key -> Encoding -> Series

pairStr :: String -> Encoding -> Series

pair' :: Encoding' Key -> Encoding -> Series

Predicates

nullEncoding :: Encoding' a -> Bool

Encoding constructors

emptyArray_ :: Encoding

emptyObject_ :: Encoding

text :: Text -> Encoding' a

lazyText :: Text -> Encoding' a

shortText :: ShortText -> Encoding' a

Since: 2.0.2.0

string :: String -> Encoding' a

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

dict

Arguments

:: (k -> Encoding' Key)

key encoding

-> (v -> Encoding)

value encoding

-> (forall a. (k -> v -> a -> a) -> a -> m -> a)

foldrWithKey - indexed fold

-> m

container

-> Encoding

Encode as JSON object

null_ :: Encoding

bool :: Bool -> Encoding

Decimal numbers

int8 :: Int8 -> Encoding

int16 :: Int16 -> Encoding

int32 :: Int32 -> Encoding

int64 :: Int64 -> Encoding

int :: Int -> Encoding

word8 :: Word8 -> Encoding

word16 :: Word16 -> Encoding

word32 :: Word32 -> Encoding

word64 :: Word64 -> Encoding

word :: Word -> Encoding

integer :: Integer -> Encoding

float :: Float -> Encoding

double :: Double -> Encoding

>>> double 42
"42.0"

>>> double (0/0)
"null"

>>> double (1/0)
"\"+inf\""

>>> double (-23/0)
"\"-inf\""

scientific :: Scientific -> Encoding

Decimal numbers as Text

int8Text :: Int8 -> Encoding' a

int16Text :: Int16 -> Encoding' a

int32Text :: Int32 -> Encoding' a

int64Text :: Int64 -> Encoding' a

intText :: Int -> Encoding' a

word8Text :: Word8 -> Encoding' a

word16Text :: Word16 -> Encoding' a

word32Text :: Word32 -> Encoding' a

word64Text :: Word64 -> Encoding' a

wordText :: Word -> Encoding' a

integerText :: Integer -> Encoding' a

floatText :: Float -> Encoding' a

doubleText :: Double -> Encoding' a

>>> doubleText 42
"\"42.0\""

>>> doubleText (0/0)
"\"NaN\""

>>> doubleText (1/0)
"\"+inf\""

>>> doubleText (-23/0)
"\"-inf\""

scientificText :: Scientific -> Encoding' a

Time

day :: Day -> Encoding' a

month :: Month -> Encoding' a

quarter :: Quarter -> Encoding' a

localTime :: LocalTime -> Encoding' a

utcTime :: UTCTime -> Encoding' a

timeOfDay :: TimeOfDay -> Encoding' a

zonedTime :: ZonedTime -> Encoding' a

value

value :: Value -> Encoding