Moduleserialise-0.2.6.1Haskell2010

Codec.Serialise.Class

The Serialise class allows you to encode a given type into a CBOR object, or decode a CBOR object into the user-specified type.

5 classes
5 values

Packageserialise-0.2.6.1
Exports10
LanguageHaskell2010
LicenceBSD-3-Clause
SourceClass.hs

The Serialise class

10 declarations

classclass Serialise a where

Types that are instances of the Serialise class allow values to be quickly encoded or decoded directly to a CBOR representation, for object transmission or storage.

Methods

encode :: a -> Encoding
Definition for encoding a given type into a binary representation, using the Encoding Monoid.
decode :: Decoder s a
Definition of a given Decoder for a type.
encodeList :: [a] -> Encoding
Utility to support specialised encoding for some list type - used for Char/String instances in this package.
decodeList :: Decoder s [a]
Utility to support specialised decoding for some list type - used for Char/String instances in this package.

Instances114Serialise, …

Serialise ByteStringDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise ByteStringDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise ShortByteStringDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise TermDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise IntSetDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise IntegerDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise NaturalDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise VoidDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise AllDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise AnyDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise SomeTypeRepDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise VersionDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise FingerprintDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CCharDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CClockDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CDoubleDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CFloatDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CIntDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CIntMaxDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CIntPtrDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CLLongDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CLongDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CPtrdiffDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CSCharDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CSUSecondsDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CShortDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CSigAtomicDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CSizeDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CTimeDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUCharDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUIntDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUIntMaxDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUIntPtrDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CULLongDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CULongDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUSecondsDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CUShortDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CWcharDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise ExitCodeDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Int16Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Int32Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Int64Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Int8Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Word16Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Word32Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Word64Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise Word8Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise BoolDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise CharDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise DoubleDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise FloatDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise IntDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise KindRepDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise LevityDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise OrderingDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise RuntimeRepDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise TyConDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise TypeLitSortDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise VecCountDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise VecElemDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise WordDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise HalfDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise TextDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise TextDefined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise UTCTimeDefined in serialise-0.2.6.1 · Codec.Serialise.Class
UTCTime is encoded using the extended time format which is currently in Internet Draft state, https://tools.ietf.org/html/draft-bormann-cbor-time-tag-00.
Serialise ()Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Complex a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (First a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Last a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Max a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Min a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (WrappedMonoid a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (IntMap a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Seq a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Tree a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (NonEmpty a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Identity a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (First a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Last a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Down a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Dual a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Product a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Sum a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (ZipList a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Maybe a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Maybe a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Vector a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise [a]Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Ord a, Serialise a) => Serialise (Set a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Storable a) => Serialise (Vector a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Integral a) => Serialise (Ratio a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Hashable a, Eq a) => Serialise (HashSet a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Prim a) => Serialise (Vector a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Unbox a) => Serialise (Vector a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Typeable a => Serialise (TypeRep a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise (Fixed e)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Values are serialised in units of least precision represented as Integer.
Serialise (Proxy a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Ord k, Serialise k, Serialise v) => Serialise (Map k v)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (Either a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (Either a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (These a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (Pair a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (These a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b) => Serialise (a, b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise k, Hashable k, Eq k, Serialise v) => Serialise (HashMap k v)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise (f a) => Serialise (Alt f a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => Serialise (Const a b)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c) => Serialise (a, b, c)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d) => Serialise (a, b, c, d)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d, Serialise e) => Serialise (a, b, c, d, e)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d, Serialise e, Serialise f) => Serialise (a, b, c, d, e, f)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d, Serialise e, Serialise f, Serialise g) => Serialise (a, b, c, d, e, f, g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d, Serialise e, Serialise f, Serialise g, Serialise h) => Serialise (a, b, c, d, e, f, g, h)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(Serialise a, Serialise b, Serialise c, Serialise d, Serialise e, Serialise f, Serialise g, Serialise h, Serialise i) => Serialise (a, b, c, d, e, f, g, h, i)Defined in serialise-0.2.6.1 · Codec.Serialise.Class

classclass GSerialiseEncode (f :: k -> Type) where

Methods

gencode :: f a -> Encoding

Instances6GSerialiseEncode

GSerialiseEncode U1Defined in serialise-0.2.6.1 · Codec.Serialise.Class
GSerialiseEncode V1Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => GSerialiseEncode (K1 i a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(GSerialiseProd f, GSerialiseProd g) => GSerialiseEncode (f :*: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(GSerialiseSum f, GSerialiseSum g) => GSerialiseEncode (f :+: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
GSerialiseEncode a => GSerialiseEncode (M1 i c a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class

classclass GSerialiseDecode (f :: k -> Type) where

Methods

gdecode :: Decoder s (f a)

Instances6GSerialiseDecode

GSerialiseDecode U1Defined in serialise-0.2.6.1 · Codec.Serialise.Class
GSerialiseDecode V1Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => GSerialiseDecode (K1 i a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(GSerialiseProd f, GSerialiseProd g) => GSerialiseDecode (f :*: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(GSerialiseSum f, GSerialiseSum g) => GSerialiseDecode (f :+: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
GSerialiseDecode a => GSerialiseDecode (M1 i c a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class

classclass GSerialiseProd (f :: k -> Type) where

Serialization of product types

Methods

nFields :: Proxy f -> Word
Number of fields in product type
encodeSeq :: f a -> Encoding
Encode fields sequentially without writing header
gdecodeSeq :: Decoder s (f a)
Decode fields sequentially without reading header

Instances4GSerialiseProd

GSerialiseProd U1Defined in serialise-0.2.6.1 · Codec.Serialise.Class
Serialise a => GSerialiseProd (K1 i a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(GSerialiseProd f, GSerialiseProd g) => GSerialiseProd (f :*: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(i ~ S, GSerialiseProd f) => GSerialiseProd (M1 i c f)Defined in serialise-0.2.6.1 · Codec.Serialise.Class

classclass GSerialiseSum (f :: k -> Type) where

Serialization of sum types

Methods

conNumber :: f a -> Word
Number of constructor of given value
numOfFields :: f a -> Word
Number of fields of given value
encodeSum :: f a -> Encoding
Encode field
decodeSum :: Word -> Decoder s (f a)
Decode field
nConstructors :: Proxy f -> Word
Number of constructors
fieldsForCon :: Proxy f -> Word -> Decoder s Word
Number of fields for given constructor number

Instances2GSerialiseSum

(GSerialiseSum f, GSerialiseSum g) => GSerialiseSum (f :+: g)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
(i ~ C, GSerialiseProd f) => GSerialiseSum (M1 i c f)Defined in serialise-0.2.6.1 · Codec.Serialise.Class

valueencodeVector :: (Serialise a, Vector v a) => v a -> Encoding

Generic encoder for vectors. Its intended use is to allow easy definition of Serialise instances for custom vector

valuedecodeVector :: (Serialise a, Vector v a) => Decoder s (v a)

Generic decoder for vectors. Its intended use is to allow easy definition of Serialise instances for custom vector

valueencodeContainerSkel

:: (Word -> Encoding)
encoder of the length
-> (container -> Int)
length
-> (accumFunc -> Encoding -> container -> Encoding)
foldr
-> accumFunc
-> container
-> Encoding

Patch functions together to obtain an Encoding for a container.

valueencodeMapSkel

:: (Serialise k, Serialise v)
=> (m -> Int)
obtain the length
-> ((k -> v -> Encoding -> Encoding) -> Encoding -> m -> Encoding)
-> m
-> Encoding

A helper function for encoding maps.

valuedecodeMapSkel

:: (Serialise k, Serialise v)
=> ([(k, v)] -> m)
fromList
-> Decoder s m

A utility function to construct a Decoder for maps.