Data.Winery

Documentation

data Schema

Constructors

SSchema !Word8

SUnit

SBool

SChar

SWord8

SWord16

SWord32

SWord64

SInt8

SInt16

SInt32

SInt64

SInteger

SFloat

SDouble

SBytes

SText

SList !Schema

SArray !(VarInt Int) !Schema

SProduct [Schema]

SProductFixed [(VarInt Int, Schema)]

SRecord [(Text, Schema)]

SVariant [(Text, [Schema])]

SFix Schema

binds a fixpoint

SSelf !Word8

SSelf n refers to the n-th innermost fixpoint

Instances

Eq Schema

Methods

(==) :: Schema -> Schema -> Bool

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

Read Schema

Methods

readsPrec :: Int -> ReadS Schema

readList :: ReadS [Schema]

readPrec :: ReadPrec Schema

readListPrec :: ReadPrec [Schema]

Show Schema

Methods

showsPrec :: Int -> Schema -> ShowS

show :: Schema -> String

showList :: [Schema] -> ShowS

Generic Schema

Associated Types

type Rep Schema :: * -> *

Methods

from :: Schema -> Rep Schema x

to :: Rep Schema x -> Schema

Pretty Schema

Methods

pretty :: Schema -> Doc ann

prettyList :: [Schema] -> Doc ann

Serialise Schema

Methods

schemaVia :: Proxy * Schema -> [TypeRep] -> Schema

toEncoding :: Schema -> Encoding

deserialiser :: Deserialiser Schema

constantSize :: Proxy * Schema -> Maybe Int

type Rep Schema

type Rep Schema = D1 * (MetaData "Schema" "Data.Winery" "winery-0-Kkn6wkyQhIYGqNxihLgi59" False) ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "SSchema" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Word8))) ((:+:) * (C1 * (MetaCons "SUnit" PrefixI False) (U1 *)) (C1 * (MetaCons "SBool" PrefixI False) (U1 *)))) ((:+:) * (C1 * (MetaCons "SChar" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SWord8" PrefixI False) (U1 *)) (C1 * (MetaCons "SWord16" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * (C1 * (MetaCons "SWord32" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SWord64" PrefixI False) (U1 *)) (C1 * (MetaCons "SInt8" PrefixI False) (U1 *)))) ((:+:) * (C1 * (MetaCons "SInt16" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SInt32" PrefixI False) (U1 *)) (C1 * (MetaCons "SInt64" PrefixI False) (U1 *)))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "SInteger" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SFloat" PrefixI False) (U1 *)) (C1 * (MetaCons "SDouble" PrefixI False) (U1 *)))) ((:+:) * (C1 * (MetaCons "SBytes" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SText" PrefixI False) (U1 *)) (C1 * (MetaCons "SList" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Schema)))))) ((:+:) * ((:+:) * (C1 * (MetaCons "SArray" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (VarInt Int))) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Schema)))) ((:+:) * (C1 * (MetaCons "SProduct" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Schema]))) (C1 * (MetaCons "SProductFixed" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(VarInt Int, Schema)]))))) ((:+:) * ((:+:) * (C1 * (MetaCons "SRecord" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Text, Schema)]))) (C1 * (MetaCons "SVariant" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Text, [Schema])])))) ((:+:) * (C1 * (MetaCons "SFix" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Schema))) (C1 * (MetaCons "SSelf" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Word8))))))))

class Typeable a => Serialise a where

Serialisable datatype

Methods

schemaVia :: Proxy a -> [TypeRep] -> Schema

Obtain the schema of the datatype. [TypeRep] is for handling recursion.

toEncoding :: a -> Encoding

Serialise a value.

deserialiser :: Deserialiser a

The Deserialiser

constantSize :: Proxy a -> Maybe Int

If this is Just x, the size of toEncoding must be x. deserialiser must not depend on this value.

schemaVia :: (Generic a, GSerialiseVariant (Rep a)) => Proxy a -> [TypeRep] -> Schema

Obtain the schema of the datatype. [TypeRep] is for handling recursion.

toEncoding :: (Generic a, GSerialiseVariant (Rep a)) => a -> Encoding

Serialise a value.

deserialiser :: (Generic a, GSerialiseVariant (Rep a)) => Deserialiser a

The Deserialiser

Instances

Serialise Bool

Methods

schemaVia :: Proxy * Bool -> [TypeRep] -> Schema

toEncoding :: Bool -> Encoding

deserialiser :: Deserialiser Bool

constantSize :: Proxy * Bool -> Maybe Int

Serialise Char

Methods

schemaVia :: Proxy * Char -> [TypeRep] -> Schema

toEncoding :: Char -> Encoding

deserialiser :: Deserialiser Char

constantSize :: Proxy * Char -> Maybe Int

Serialise Double

Methods

schemaVia :: Proxy * Double -> [TypeRep] -> Schema

toEncoding :: Double -> Encoding

deserialiser :: Deserialiser Double

constantSize :: Proxy * Double -> Maybe Int

Serialise Float

Methods

schemaVia :: Proxy * Float -> [TypeRep] -> Schema

toEncoding :: Float -> Encoding

deserialiser :: Deserialiser Float

constantSize :: Proxy * Float -> Maybe Int

Serialise Int

Methods

schemaVia :: Proxy * Int -> [TypeRep] -> Schema

toEncoding :: Int -> Encoding

deserialiser :: Deserialiser Int

constantSize :: Proxy * Int -> Maybe Int

Serialise Int8

Methods

schemaVia :: Proxy * Int8 -> [TypeRep] -> Schema

toEncoding :: Int8 -> Encoding

deserialiser :: Deserialiser Int8

constantSize :: Proxy * Int8 -> Maybe Int

Serialise Int16

Methods

schemaVia :: Proxy * Int16 -> [TypeRep] -> Schema

toEncoding :: Int16 -> Encoding

deserialiser :: Deserialiser Int16

constantSize :: Proxy * Int16 -> Maybe Int

Serialise Int32

Methods

schemaVia :: Proxy * Int32 -> [TypeRep] -> Schema

toEncoding :: Int32 -> Encoding

deserialiser :: Deserialiser Int32

constantSize :: Proxy * Int32 -> Maybe Int

Serialise Int64

Methods

schemaVia :: Proxy * Int64 -> [TypeRep] -> Schema

toEncoding :: Int64 -> Encoding

deserialiser :: Deserialiser Int64

constantSize :: Proxy * Int64 -> Maybe Int

Serialise Integer

Methods

schemaVia :: Proxy * Integer -> [TypeRep] -> Schema

toEncoding :: Integer -> Encoding

deserialiser :: Deserialiser Integer

constantSize :: Proxy * Integer -> Maybe Int

Serialise Word

Methods

schemaVia :: Proxy * Word -> [TypeRep] -> Schema

toEncoding :: Word -> Encoding

deserialiser :: Deserialiser Word

constantSize :: Proxy * Word -> Maybe Int

Serialise Word8

Methods

schemaVia :: Proxy * Word8 -> [TypeRep] -> Schema

toEncoding :: Word8 -> Encoding

deserialiser :: Deserialiser Word8

constantSize :: Proxy * Word8 -> Maybe Int

Serialise Word16

Methods

schemaVia :: Proxy * Word16 -> [TypeRep] -> Schema

toEncoding :: Word16 -> Encoding

deserialiser :: Deserialiser Word16

constantSize :: Proxy * Word16 -> Maybe Int

Serialise Word32

Methods

schemaVia :: Proxy * Word32 -> [TypeRep] -> Schema

toEncoding :: Word32 -> Encoding

deserialiser :: Deserialiser Word32

constantSize :: Proxy * Word32 -> Maybe Int

Serialise Word64

Methods

schemaVia :: Proxy * Word64 -> [TypeRep] -> Schema

toEncoding :: Word64 -> Encoding

deserialiser :: Deserialiser Word64

constantSize :: Proxy * Word64 -> Maybe Int

Serialise ()

Methods

schemaVia :: Proxy * () -> [TypeRep] -> Schema

toEncoding :: () -> Encoding

deserialiser :: Deserialiser ()

constantSize :: Proxy * () -> Maybe Int

Serialise ByteString

Methods

schemaVia :: Proxy * ByteString -> [TypeRep] -> Schema

toEncoding :: ByteString -> Encoding

deserialiser :: Deserialiser ByteString

constantSize :: Proxy * ByteString -> Maybe Int

Serialise IntSet

Methods

schemaVia :: Proxy * IntSet -> [TypeRep] -> Schema

toEncoding :: IntSet -> Encoding

deserialiser :: Deserialiser IntSet

constantSize :: Proxy * IntSet -> Maybe Int

Serialise Text

Methods

schemaVia :: Proxy * Text -> [TypeRep] -> Schema

toEncoding :: Text -> Encoding

deserialiser :: Deserialiser Text

constantSize :: Proxy * Text -> Maybe Int

Serialise Schema

Methods

schemaVia :: Proxy * Schema -> [TypeRep] -> Schema

toEncoding :: Schema -> Encoding

deserialiser :: Deserialiser Schema

constantSize :: Proxy * Schema -> Maybe Int

Serialise a => Serialise [a]

Methods

schemaVia :: Proxy * [a] -> [TypeRep] -> Schema

toEncoding :: [a] -> Encoding

deserialiser :: Deserialiser [a]

constantSize :: Proxy * [a] -> Maybe Int

Serialise a => Serialise (Maybe a)

Methods

schemaVia :: Proxy * (Maybe a) -> [TypeRep] -> Schema

toEncoding :: Maybe a -> Encoding

deserialiser :: Deserialiser (Maybe a)

constantSize :: Proxy * (Maybe a) -> Maybe Int

Serialise a => Serialise (Identity a)

Methods

schemaVia :: Proxy * (Identity a) -> [TypeRep] -> Schema

toEncoding :: Identity a -> Encoding

deserialiser :: Deserialiser (Identity a)

constantSize :: Proxy * (Identity a) -> Maybe Int

Serialise v => Serialise (IntMap v)

Methods

schemaVia :: Proxy * (IntMap v) -> [TypeRep] -> Schema

toEncoding :: IntMap v -> Encoding

deserialiser :: Deserialiser (IntMap v)

constantSize :: Proxy * (IntMap v) -> Maybe Int

Serialise a => Serialise (Seq a)

Methods

schemaVia :: Proxy * (Seq a) -> [TypeRep] -> Schema

toEncoding :: Seq a -> Encoding

deserialiser :: Deserialiser (Seq a)

constantSize :: Proxy * (Seq a) -> Maybe Int

(Ord a, Serialise a) => Serialise (Set a)

Methods

schemaVia :: Proxy * (Set a) -> [TypeRep] -> Schema

toEncoding :: Set a -> Encoding

deserialiser :: Deserialiser (Set a)

constantSize :: Proxy * (Set a) -> Maybe Int

(Unbox a, Serialise a) => Serialise (Vector a)

Methods

schemaVia :: Proxy * (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy * (Vector a) -> Maybe Int

(Storable a, Serialise a) => Serialise (Vector a)

Methods

schemaVia :: Proxy * (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy * (Vector a) -> Maybe Int

Serialise a => Serialise (Vector a)

Methods

schemaVia :: Proxy * (Vector a) -> [TypeRep] -> Schema

toEncoding :: Vector a -> Encoding

deserialiser :: Deserialiser (Vector a)

constantSize :: Proxy * (Vector a) -> Maybe Int

(Typeable * a, Integral a, Bits a) => Serialise (VarInt a)

Methods

schemaVia :: Proxy * (VarInt a) -> [TypeRep] -> Schema

toEncoding :: VarInt a -> Encoding

deserialiser :: Deserialiser (VarInt a)

constantSize :: Proxy * (VarInt a) -> Maybe Int

(Serialise a, Serialise b) => Serialise (Either a b)

Methods

schemaVia :: Proxy * (Either a b) -> [TypeRep] -> Schema

toEncoding :: Either a b -> Encoding

deserialiser :: Deserialiser (Either a b)

constantSize :: Proxy * (Either a b) -> Maybe Int

(Serialise a, Serialise b) => Serialise (a, b)

Methods

schemaVia :: Proxy * (a, b) -> [TypeRep] -> Schema

toEncoding :: (a, b) -> Encoding

deserialiser :: Deserialiser (a, b)

constantSize :: Proxy * (a, b) -> Maybe Int

(Ord k, Serialise k, Serialise v) => Serialise (Map k v)

Methods

schemaVia :: Proxy * (Map k v) -> [TypeRep] -> Schema

toEncoding :: Map k v -> Encoding

deserialiser :: Deserialiser (Map k v)

constantSize :: Proxy * (Map k v) -> Maybe Int

(Eq k, Hashable k, Serialise k, Serialise v) => Serialise (HashMap k v)

Methods

schemaVia :: Proxy * (HashMap k v) -> [TypeRep] -> Schema

toEncoding :: HashMap k v -> Encoding

deserialiser :: Deserialiser (HashMap k v)

constantSize :: Proxy * (HashMap k v) -> Maybe Int

(Serialise a, Serialise b, Serialise c) => Serialise (a, b, c)

Methods

schemaVia :: Proxy * (a, b, c) -> [TypeRep] -> Schema

toEncoding :: (a, b, c) -> Encoding

deserialiser :: Deserialiser (a, b, c)

constantSize :: Proxy * (a, b, c) -> Maybe Int

(Serialise a, Serialise b, Serialise c, Serialise d) => Serialise (a, b, c, d)

Methods

schemaVia :: Proxy * (a, b, c, d) -> [TypeRep] -> Schema

toEncoding :: (a, b, c, d) -> Encoding

deserialiser :: Deserialiser (a, b, c, d)

constantSize :: Proxy * (a, b, c, d) -> Maybe Int

schema :: forall proxy a. Serialise a => proxy a -> Schema

Obtain the schema of the datatype.

Standalone serialisation

serialise :: Serialise a => a -> ByteString

Serialise a value along with its schema.

deserialise :: Serialise a => ByteString -> Either StrategyError a

Deserialise a serialised Bytestring.

Separate serialisation

newtype Deserialiser a

Deserialiser is a Plan that creates a Decoder.

Constructors

Deserialiser

Fields

• getDeserialiser :: Plan (Decoder a)

Instances

Functor Deserialiser

Methods

fmap :: (a -> b) -> Deserialiser a -> Deserialiser b

(<$) :: a -> Deserialiser b -> Deserialiser a

Applicative Deserialiser

Methods

pure :: a -> Deserialiser a

(<*>) :: Deserialiser (a -> b) -> Deserialiser a -> Deserialiser b

liftA2 :: (a -> b -> c) -> Deserialiser a -> Deserialiser b -> Deserialiser c

(*>) :: Deserialiser a -> Deserialiser b -> Deserialiser b

(<*) :: Deserialiser a -> Deserialiser b -> Deserialiser a

type Decoder = (->) ByteString

serialiseOnly :: Serialise a => a -> ByteString

Serialise a value without its schema.

getDecoder :: Serialise a => Schema -> Either StrategyError (Decoder a)

Obtain a decoder from a schema.

getDecoderBy :: Deserialiser a -> Schema -> Either StrategyError (Decoder a)

Get a decoder from a Deserialiser and a schema.

Encoding combinators

type Encoding = (Sum Int, Builder)

encodeMulti :: [Encoding] -> Encoding

Decoding combinators

newtype Plan a

Constructors

Plan

Fields

• unPlan :: Schema -> Strategy a

Instances

Monad Plan

Methods

(>>=) :: Plan a -> (a -> Plan b) -> Plan b

(>>) :: Plan a -> Plan b -> Plan b

return :: a -> Plan a

fail :: String -> Plan a

Functor Plan

Methods

fmap :: (a -> b) -> Plan a -> Plan b

(<$) :: a -> Plan b -> Plan a

Applicative Plan

Methods

pure :: a -> Plan a

(<*>) :: Plan (a -> b) -> Plan a -> Plan b

liftA2 :: (a -> b -> c) -> Plan a -> Plan b -> Plan c

(*>) :: Plan a -> Plan b -> Plan b

(<*) :: Plan a -> Plan b -> Plan a

Alternative Plan

Methods

empty :: Plan a

(<|>) :: Plan a -> Plan a -> Plan a

some :: Plan a -> Plan [a]

many :: Plan a -> Plan [a]

extractListWith :: Deserialiser a -> Deserialiser [a]

Extract a list or an array of values.

extractField :: Serialise a => Text -> Deserialiser a

Extract a field of a record.

extractFieldWith :: Typeable a => Deserialiser a -> Text -> Deserialiser a

Extract a field using the supplied Deserialiser.

extractConstructor :: Serialise a => Text -> Deserialiser (Maybe a)

extractConstructorWith :: Typeable a => Deserialiser a -> Text -> Deserialiser (Maybe a)

Tries to extract a specific constructor of a variant. Useful for implementing backward-compatible deserialisers.

Variable-length quantity

newtype VarInt a

Encoded in variable-length quantity.

Constructors

VarInt

Fields

• getVarInt :: a

Instances

Bounded a => Bounded (VarInt a)

Methods

minBound :: VarInt a

maxBound :: VarInt a

Enum a => Enum (VarInt a)

Methods

succ :: VarInt a -> VarInt a

pred :: VarInt a -> VarInt a

toEnum :: Int -> VarInt a

fromEnum :: VarInt a -> Int

enumFrom :: VarInt a -> [VarInt a]

enumFromThen :: VarInt a -> VarInt a -> [VarInt a]

enumFromTo :: VarInt a -> VarInt a -> [VarInt a]

enumFromThenTo :: VarInt a -> VarInt a -> VarInt a -> [VarInt a]

Eq a => Eq (VarInt a)

Methods

(==) :: VarInt a -> VarInt a -> Bool

(/=) :: VarInt a -> VarInt a -> Bool

Integral a => Integral (VarInt a)

Methods

quot :: VarInt a -> VarInt a -> VarInt a

rem :: VarInt a -> VarInt a -> VarInt a

div :: VarInt a -> VarInt a -> VarInt a

mod :: VarInt a -> VarInt a -> VarInt a

quotRem :: VarInt a -> VarInt a -> (VarInt a, VarInt a)

divMod :: VarInt a -> VarInt a -> (VarInt a, VarInt a)

toInteger :: VarInt a -> Integer

Num a => Num (VarInt a)

Methods

(+) :: VarInt a -> VarInt a -> VarInt a

(-) :: VarInt a -> VarInt a -> VarInt a

(*) :: VarInt a -> VarInt a -> VarInt a

negate :: VarInt a -> VarInt a

abs :: VarInt a -> VarInt a

signum :: VarInt a -> VarInt a

fromInteger :: Integer -> VarInt a

Ord a => Ord (VarInt a)

Methods

compare :: VarInt a -> VarInt a -> Ordering

(<) :: VarInt a -> VarInt a -> Bool

(<=) :: VarInt a -> VarInt a -> Bool

(>) :: VarInt a -> VarInt a -> Bool

(>=) :: VarInt a -> VarInt a -> Bool

max :: VarInt a -> VarInt a -> VarInt a

min :: VarInt a -> VarInt a -> VarInt a

Read a => Read (VarInt a)

Methods

readsPrec :: Int -> ReadS (VarInt a)

readList :: ReadS [VarInt a]

readPrec :: ReadPrec (VarInt a)

readListPrec :: ReadPrec [VarInt a]

Real a => Real (VarInt a)

Methods

toRational :: VarInt a -> Rational

Show a => Show (VarInt a)

Methods

showsPrec :: Int -> VarInt a -> ShowS

show :: VarInt a -> String

showList :: [VarInt a] -> ShowS

Bits a => Bits (VarInt a)

Methods

(.&.) :: VarInt a -> VarInt a -> VarInt a

(.|.) :: VarInt a -> VarInt a -> VarInt a

xor :: VarInt a -> VarInt a -> VarInt a

complement :: VarInt a -> VarInt a

shift :: VarInt a -> Int -> VarInt a

rotate :: VarInt a -> Int -> VarInt a

zeroBits :: VarInt a

bit :: Int -> VarInt a

setBit :: VarInt a -> Int -> VarInt a

clearBit :: VarInt a -> Int -> VarInt a

complementBit :: VarInt a -> Int -> VarInt a

testBit :: VarInt a -> Int -> Bool

bitSizeMaybe :: VarInt a -> Maybe Int

bitSize :: VarInt a -> Int

isSigned :: VarInt a -> Bool

shiftL :: VarInt a -> Int -> VarInt a

unsafeShiftL :: VarInt a -> Int -> VarInt a

shiftR :: VarInt a -> Int -> VarInt a

unsafeShiftR :: VarInt a -> Int -> VarInt a

rotateL :: VarInt a -> Int -> VarInt a

rotateR :: VarInt a -> Int -> VarInt a

popCount :: VarInt a -> Int

(Typeable * a, Integral a, Bits a) => Serialise (VarInt a)

Methods

schemaVia :: Proxy * (VarInt a) -> [TypeRep] -> Schema

toEncoding :: VarInt a -> Encoding

deserialiser :: Deserialiser (VarInt a)

constantSize :: Proxy * (VarInt a) -> Maybe Int

Internal

unwrapDeserialiser :: Deserialiser a -> Schema -> Strategy (Decoder a)

data Strategy a

Instances

Monad Strategy

Methods

(>>=) :: Strategy a -> (a -> Strategy b) -> Strategy b

(>>) :: Strategy a -> Strategy b -> Strategy b

return :: a -> Strategy a

fail :: String -> Strategy a

Functor Strategy

Methods

fmap :: (a -> b) -> Strategy a -> Strategy b

(<$) :: a -> Strategy b -> Strategy a

MonadFix Strategy

Methods

mfix :: (a -> Strategy a) -> Strategy a

Applicative Strategy

Methods

pure :: a -> Strategy a

(<*>) :: Strategy (a -> b) -> Strategy a -> Strategy b

liftA2 :: (a -> b -> c) -> Strategy a -> Strategy b -> Strategy c

(*>) :: Strategy a -> Strategy b -> Strategy b

(<*) :: Strategy a -> Strategy b -> Strategy a

Alternative Strategy

Methods

empty :: Strategy a

(<|>) :: Strategy a -> Strategy a -> Strategy a

some :: Strategy a -> Strategy [a]

many :: Strategy a -> Strategy [a]

type StrategyError = Doc AnsiStyle

Generics

class GSerialiseRecord f

Minimal complete definition

recordSchema, recordEncoder, recordDecoder

Instances

GSerialiseRecord k f => GSerialiseRecord k (D1 k c f)

Methods

recordSchema :: proxy f -> [TypeRep] -> [(Text, Schema)]

recordEncoder :: f x -> [Encoding]

recordDecoder :: Maybe (f x) -> RecordDecoder Text (Decoder (f x))

GSerialiseRecord k f => GSerialiseRecord k (C1 k c f)

Methods

recordSchema :: proxy f -> [TypeRep] -> [(Text, Schema)]

recordEncoder :: f x -> [Encoding]

recordDecoder :: Maybe (f x) -> RecordDecoder Text (Decoder (f x))

(GSerialiseRecord k f, GSerialiseRecord k g) => GSerialiseRecord k ((:*:) k f g)

Methods

recordSchema :: proxy f -> [TypeRep] -> [(Text, Schema)]

recordEncoder :: f x -> [Encoding]

recordDecoder :: Maybe (f x) -> RecordDecoder Text (Decoder (f x))

(Serialise a, Selector Meta c) => GSerialiseRecord k (S1 k c (K1 k i a))

Methods

recordSchema :: proxy f -> [TypeRep] -> [(Text, Schema)]

recordEncoder :: f x -> [Encoding]

recordDecoder :: Maybe (f x) -> RecordDecoder Text (Decoder (f x))

gschemaViaRecord :: forall proxy a. (GSerialiseRecord (Rep a), Generic a, Typeable a) => proxy a -> [TypeRep] -> Schema

Generic implementation of schemaVia for a record.

gtoEncodingRecord :: (GSerialiseRecord (Rep a), Generic a) => a -> Encoding

Generic implementation of toEncoding for a record.

gdeserialiserRecord

Arguments

:: (GSerialiseRecord (Rep a), Generic a, Typeable a)

=> Maybe a

default value (optional)

-> Deserialiser a

Generic implementation of deserialiser for a record.

class GSerialiseVariant f

Minimal complete definition

variantCount, variantSchema, variantEncoder, variantDecoder

Instances

GSerialiseVariant k f => GSerialiseVariant k (D1 k c f)

Methods

variantCount :: proxy f -> Int

variantSchema :: proxy f -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (f x)))]

GSerialiseVariant k f => GSerialiseVariant k (S1 k c f)

Methods

variantCount :: proxy f -> Int

variantSchema :: proxy f -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (f x)))]

(GSerialiseProduct k f, Constructor Meta c) => GSerialiseVariant k (C1 k c f)

Methods

variantCount :: proxy f -> Int

variantSchema :: proxy f -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (f x)))]

(GSerialiseVariant k f, GSerialiseVariant k g) => GSerialiseVariant k ((:+:) k f g)

Methods

variantCount :: proxy f -> Int

variantSchema :: proxy f -> [TypeRep] -> [(Text, [Schema])]

variantEncoder :: Int -> f x -> Encoding

variantDecoder :: [(Text, [Schema] -> Strategy (Decoder (f x)))]

gschemaViaVariant :: forall proxy a. (GSerialiseVariant (Rep a), Typeable a, Generic a) => proxy a -> [TypeRep] -> Schema

Generic implementation of schemaVia for an ADT.

gtoEncodingVariant :: (GSerialiseVariant (Rep a), Generic a) => a -> Encoding

Generic implementation of toEncoding for an ADT.

gdeserialiserVariant :: forall a. (GSerialiseVariant (Rep a), Generic a, Typeable a) => Deserialiser a

Generic implementation of deserialiser for an ADT.

Preset schema

bootstrapSchema :: Word8 -> Either StrategyError Schema