Proto3.Suite.JSONPB.Class

Support for the JSONPB canonical JSON encoding described at https://developers.google.com/protocol-buffers/docs/proto3#json.

This modules provides Aeson-like helper functions, typeclasses, and instances for converting to and from values of types which have a JSONPB representation and equivalent underlying Aeson representations.

This module also presents a (very minimal) surface syntax for Aeson-like operations; the idea is that we can write ToJSONPB and FromJSONPB instances in a very similar manner to ToJSON and FromJSON instances, except that doing so specifies JSONPB codecs instead of vanilla JSON codecs.

Example use:

message Scalar32 {
  int32     i32 = 1;
  uint32    u32 = 2;
  sint32    s32 = 3;
  fixed32   f32 = 4;
  sfixed32 sf32 = 5;
}

instance ToJSONPB Scalar32 where
  toJSONPB (Scalar32 i32 u32 s32 f32 sf32) = object
      [ "i32"  .= i32
      , "u32"  .= u32
      , "s32"  .= s32
      , "f32"  .= f32
      , "sf32" .= sf32
      ]
  toEncodingPB (Scalar32 i32 u32 s32 f32 sf32) = pairs
      [ "i32"  .= i32
      , "u32"  .= u32
      , "s32"  .= s32
      , "f32"  .= f32
      , "sf32" .= sf32
      ]

instance FromJSONPB Scalar32 where
  parseJSONPB = withObject Scalar32 $ obj ->
    pure Scalar32
    * obj .: "i32"
    * obj .: "u32"
    * obj .: "s32"
    * obj .: "f32"
    * obj .: "sf32"

Documentation

type Key = Key

keyFromText :: Text -> Key

Typeclass definitions

class ToJSONPB a where

ToJSON variant for JSONPB direct encoding via Encoding

Minimal complete definition

toJSONPB

Methods

toJSONPB :: a -> Options -> Value

toJSON variant for JSONPB encoders.

toEncodingPB :: a -> Options -> Encoding

toEncoding variant for JSONPB encoders. If an implementation is not provided, uses toJSONPB (which is less efficient since it indirects through the Value IR).

Instances

ToJSONPB Bool

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Bool -> Options -> Value

toEncodingPB :: Bool -> Options -> Encoding

ToJSONPB Double

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Double -> Options -> Value

toEncodingPB :: Double -> Options -> Encoding

ToJSONPB Float

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Float -> Options -> Value

toEncodingPB :: Float -> Options -> Encoding

ToJSONPB Int32

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Int32 -> Options -> Value

toEncodingPB :: Int32 -> Options -> Encoding

ToJSONPB Int64

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Int64 -> Options -> Value

toEncodingPB :: Int64 -> Options -> Encoding

ToJSONPB Word32

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Word32 -> Options -> Value

toEncodingPB :: Word32 -> Options -> Encoding

ToJSONPB Word64

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Word64 -> Options -> Value

toEncodingPB :: Word64 -> Options -> Encoding

ToJSONPB ByteString

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: ByteString -> Options -> Value

toEncodingPB :: ByteString -> Options -> Encoding

ToJSONPB Encoding

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Encoding -> Options -> Value

toEncodingPB :: Encoding -> Options -> Encoding

ToJSONPB Value

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Value -> Options -> Value

toEncodingPB :: Value -> Options -> Encoding

ToJSONPB Text

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Text -> Options -> Value

toEncodingPB :: Text -> Options -> Encoding

ToJSONPB Timestamp

Defined in Google.Protobuf.Timestamp

Methods

toJSONPB :: Timestamp -> Options -> Value

toEncodingPB :: Timestamp -> Options -> Encoding

ToJSONPB a => ToJSONPB (Maybe a)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Maybe a -> Options -> Value

toEncodingPB :: Maybe a -> Options -> Encoding

ToJSONPB a => ToJSONPB (Vector a)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Vector a -> Options -> Value

toEncodingPB :: Vector a -> Options -> Encoding

ToJSONPB e => ToJSONPB (Enumerated e)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Enumerated e -> Options -> Value

toEncodingPB :: Enumerated e -> Options -> Encoding

ToJSONPB (Fixed Int32)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Fixed Int32 -> Options -> Value

toEncodingPB :: Fixed Int32 -> Options -> Encoding

ToJSONPB (Fixed Int64)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Fixed Int64 -> Options -> Value

toEncodingPB :: Fixed Int64 -> Options -> Encoding

ToJSONPB (Fixed Word32)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Fixed Word32 -> Options -> Value

toEncodingPB :: Fixed Word32 -> Options -> Encoding

ToJSONPB (Fixed Word64)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Fixed Word64 -> Options -> Value

toEncodingPB :: Fixed Word64 -> Options -> Encoding

(ToJSONKey k, ToJSONPB k, ToJSONPB v) => ToJSONPB (Map k v)

Defined in Proto3.Suite.JSONPB.Class

Methods

toJSONPB :: Map k v -> Options -> Value

toEncodingPB :: Map k v -> Options -> Encoding

class FromJSONPB a where

FromJSON variant for JSONPB decoding from the Value IR

Methods

parseJSONPB :: Value -> Parser a

parseJSON variant for JSONPB decoders.

Instances

FromJSONPB Bool

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Bool

FromJSONPB Double

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Double

FromJSONPB Float

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Float

FromJSONPB Int32

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Int32

FromJSONPB Int64

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Int64

FromJSONPB Word32

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Word32

FromJSONPB Word64

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Word64

FromJSONPB ByteString

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser ByteString

FromJSONPB Value

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Value

FromJSONPB Text

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Text

FromJSONPB Timestamp

Defined in Google.Protobuf.Timestamp

Methods

parseJSONPB :: Value -> Parser Timestamp

FromJSONPB a => FromJSONPB (Maybe a)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Maybe a)

FromJSONPB a => FromJSONPB (Vector a)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Vector a)

(ProtoEnum e, FromJSONPB e) => FromJSONPB (Enumerated e)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Enumerated e)

FromJSONPB (Fixed Int32)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Fixed Int32)

FromJSONPB (Fixed Int64)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Fixed Int64)

FromJSONPB (Fixed Word32)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Fixed Word32)

FromJSONPB (Fixed Word64)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Fixed Word64)

(Ord k, FromJSONKey k, FromJSONPB k, FromJSONPB v) => FromJSONPB (Map k v)

Defined in Proto3.Suite.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Map k v)

JSONPB codec entry points

encode :: ToJSONPB a => Options -> a -> ByteString

encode variant for serializing a JSONPB value as a lazy ByteString.

eitherDecode :: FromJSONPB a => ByteString -> Either String a

eitherDecode variant for deserializing a JSONPB value from a lazy ByteString.

Operator definitions

class Monoid m => KeyValuePB m where

JSONPB-encoded monoidal key-value pairs

Methods

pair :: ToJSONPB v => Text -> v -> Options -> m

Instances

KeyValuePB Series

Defined in Proto3.Suite.JSONPB.Class

Methods

pair :: ToJSONPB v => Text -> v -> Options -> Series

KeyValuePB [Pair]

Defined in Proto3.Suite.JSONPB.Class

Methods

pair :: ToJSONPB v => Text -> v -> Options -> [Pair]

(.=) :: (HasDefault v, ToJSONPB v, KeyValuePB kvp) => Text -> v -> Options -> kvp

Construct a monoidal key-value pair, using mempty to represent omission of default values (unless the given Options force their emission).

(.:) :: (FromJSONPB a, HasDefault a) => Object -> Text -> Parser a

.: variant for JSONPB; if the given key is missing from the object, or if it is present but its value is null, we produce the default protobuf value for the field type

parseField :: FromJSONPB a => Object -> Key -> Parser a

JSONPB rendering and parsing options

data Options

Constructors

Options

Fields

• optEmitDefaultValuedFields :: Bool
• optEmitNamedOneof :: Bool

  For compatibility with the Go JSONPB implementation.

  If False, the following message

  message MyMessage {
    oneof animal {
      Cat cat = 1;
      Dog dog = 2;
    }
  }

  will be serialized as

  MyMessage (Animal (Cat "Simba")) => { "cat": "Simba" }

  instead of

  MyMessage (Animal (Cat "Simba")) => { "animal": { "cat": "Simba" } }

Instances

Eq Options

Defined in Proto3.Suite.JSONPB.Class

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

Show Options

Defined in Proto3.Suite.JSONPB.Class

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

Generic Options

Defined in Proto3.Suite.JSONPB.Class

Associated Types

type Rep Options :: Type -> Type

Methods

from :: Options -> Rep Options x

to :: Rep Options x -> Options

Arbitrary Options

Defined in Proto3.Suite.JSONPB.Class

Methods

arbitrary :: Gen Options

shrink :: Options -> [Options]

type Rep Options

Defined in Proto3.Suite.JSONPB.Class

type Rep Options = D1 ('MetaData "Options" "Proto3.Suite.JSONPB.Class" "proto3-suite-0.5.1-KgIMs0pOzZ0CPM0GxpZWzf" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) (S1 ('MetaSel ('Just "optEmitDefaultValuedFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optEmitNamedOneof") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

defaultOptions :: Options

Default options for JSON encoding. By default, all options are True.

jsonPBOptions :: Options

Options for JSONPB encoding.

Helper types and functions

dropNamedPrefix :: Named a => Proxy# a -> String -> String

object :: [Options -> [Pair]] -> Options -> Value

objectOrNull :: [Options -> [Pair]] -> Options -> Value

As object, but produces Null when there are no pairs to wrap (cf. the empty object result of 'object)

>>> object [const []] defaultOptions
Object (fromList [])
>>> objectOrNull [const []] defaultOptions
Null

pairs :: [Options -> Series] -> Options -> Encoding

pairsOrNull :: [Options -> Series] -> Options -> Encoding

As pairs, but produces the "null" when there is no series to encode (cf. the empty object encoding of pairs)

>>> pairs [const mempty] defaultOptions
"{}"
>>> pairsOrNull [const mempty] defaultOptions
"null"

enumFieldString :: forall a. (Named a, Show a) => a -> Value

enumFieldEncoding :: forall a. (Named a, Show a) => a -> Encoding

toAesonValue :: ToJSONPB a => a -> Value

A Aeson Value encoder for values which can be JSONPB-encoded.

toAesonEncoding :: ToJSONPB a => a -> Encoding

A direct Encoding for values which can be JSONPB-encoded.

parseFP :: (FromJSON a, FromJSONKey a) => String -> Value -> Parser a

Parse a JSONPB floating point value; first parameter provides context for type mismatches

parseNumOrDecimalString :: FromJSON a => String -> Value -> Parser a

Liberally parse an integer value (e.g. 42 or "42" as 42); first parameter provides context for type mismatches

Common instances for jsonpb codec implementations

Instances for scalar types

bsToJSONPB :: ByteString -> Value

enumToJSONPB

Arguments

:: (e -> Options -> a)

JSONPB encoder function to use

-> a

null value to use for out-of-range enums

-> Enumerated e

the enumerated value to encode

-> Options

JSONPB encoding options

-> a

the JSONPB-encoded value

Instances for composite types

Orphan instances

HasDefault Encoding

>>> isDefault (def @E.Encoding)
True

Methods

def :: Encoding

isDefault :: Encoding -> Bool

HasDefault Value

>>> isDefault (def @A.Value)
True

Methods

def :: Value

isDefault :: Value -> Bool