Data.ProtoLens.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"

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 Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Bool -> Options -> Value

toEncodingPB :: Bool -> Options -> Encoding

ToJSONPB Double

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Double -> Options -> Value

toEncodingPB :: Double -> Options -> Encoding

ToJSONPB Float

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Float -> Options -> Value

toEncodingPB :: Float -> Options -> Encoding

ToJSONPB Int32

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Int32 -> Options -> Value

toEncodingPB :: Int32 -> Options -> Encoding

ToJSONPB Int64

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Int64 -> Options -> Value

toEncodingPB :: Int64 -> Options -> Encoding

ToJSONPB Word32

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Word32 -> Options -> Value

toEncodingPB :: Word32 -> Options -> Encoding

ToJSONPB Word64

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Word64 -> Options -> Value

toEncodingPB :: Word64 -> Options -> Encoding

ToJSONPB ByteString

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: ByteString -> Options -> Value

toEncodingPB :: ByteString -> Options -> Encoding

ToJSONPB Text

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Text -> Options -> Value

toEncodingPB :: Text -> Options -> Encoding

ToJSONPB Text

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Text -> Options -> Value

toEncodingPB :: Text -> Options -> Encoding

ToJSONPB a => ToJSONPB [a]

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: [a] -> Options -> Value

toEncodingPB :: [a] -> Options -> Encoding

ToJSONPB a => ToJSONPB (Maybe a)

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Maybe a -> Options -> Value

toEncodingPB :: Maybe a -> Options -> Encoding

ToJSONPB a => ToJSONPB (Vector a)

Defined in Data.ProtoLens.JSONPB.Class

Methods

toJSONPB :: Vector a -> Options -> Value

toEncodingPB :: Vector a -> 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 Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Bool

FromJSONPB Double

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Double

FromJSONPB Float

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Float

FromJSONPB Int32

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Int32

FromJSONPB Int64

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Int64

FromJSONPB Word32

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Word32

FromJSONPB Word64

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Word64

FromJSONPB ByteString

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser ByteString

FromJSONPB Text

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Text

FromJSONPB Text

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser Text

FromJSONPB a => FromJSONPB [a]

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser [a]

FromJSONPB a => FromJSONPB (Maybe a)

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Maybe a)

FromJSONPB a => FromJSONPB (Vector a)

Defined in Data.ProtoLens.JSONPB.Class

Methods

parseJSONPB :: Value -> Parser (Vector a)

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 Data.ProtoLens.JSONPB.Class

Methods

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

KeyValuePB [Pair]

Defined in Data.ProtoLens.JSONPB.Class

Methods

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

(.=) :: (ToJSONPB v, KeyValuePB kvp, FieldDefault v, Eq v) => 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, FieldDefault 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 -> Text -> Parser a

JSONPB rendering and parsing options

data Options

Constructors

Options

Fields

• optEmitDefaultValuedFields :: Bool

Instances

Show Options

Defined in Data.ProtoLens.JSONPB.Class

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

defaultOptions :: Options

Default options for JSONPB encoding. By default, all options are False.

Helper types and functions

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

pairs :: [Options -> Series] -> Options -> 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

Instances for composite types

Orphan instances

FieldDefault [a]

Methods

fieldDefault :: [a]

FieldDefault (Maybe a)

Methods

fieldDefault :: Maybe a