Data.SerDoc.Class

Typeclasses

class Codec codec

Abstracts over an individual serializer / deserializer, a.k.a., a "codec". A codec typically provides a serializer, deserializer, and metadata for each serializable type; however, for various reasons, the Codec typeclass itself only captures the associated types that are involved in serializing and deserializing.

Associated Types

type MonadEncode codec :: Type -> Type

The Monad in which encoding can happen.

type MonadDecode codec :: Type -> Type

The Monad in which decoding can happen.

type DefEnumEncoding codec :: Type

Unless explicitly declared otherwise, enum fields will be encoded as this type.

type DefEnumEncoding codec = Word16

class Codec codec => Serializable codec a where

Serialization and deserialization API for a Codec.

Methods

encode :: Proxy codec -> a -> MonadEncode codec ()

Encode / serialize a value.

decode :: Proxy codec -> MonadDecode codec a

Decode / deserialize a value.

Instances

(Enum a, Bounded a, Codec codec, Integral (DefEnumEncoding codec), Num (DefEnumEncoding codec), Monad (MonadEncode codec), Monad (MonadDecode codec), Serializable codec (DefEnumEncoding codec)) => Serializable codec (ViaEnum a)

Defined in Data.SerDoc.Class

Methods

encode :: Proxy codec -> ViaEnum a -> MonadEncode codec ()

decode :: Proxy codec -> MonadDecode codec (ViaEnum a)

class Codec codec => HasInfo codec a where

Serialization metadata for a Codec.

Methods

info :: Proxy codec -> Proxy a -> FieldInfo codec

Instances

(Enum a, Bounded a, Typeable a, Show a, Codec codec, HasInfo codec (DefEnumEncoding codec)) => HasInfo codec (ViaEnum a)

Defined in Data.SerDoc.Class

Methods

info :: Proxy codec -> Proxy (ViaEnum a) -> FieldInfo codec

Helpers For Writing Instances

newtype ViaEnum a

Newtype wrapper for deriving / defining HasInfo and Serializable instances for enum types.

Constructors

ViaEnum

Fields

• viaEnum :: a

Instances

(Enum a, Bounded a, Typeable a, Show a, Codec codec, HasInfo codec (DefEnumEncoding codec)) => HasInfo codec (ViaEnum a)

Defined in Data.SerDoc.Class

Methods

info :: Proxy codec -> Proxy (ViaEnum a) -> FieldInfo codec

(Enum a, Bounded a, Codec codec, Integral (DefEnumEncoding codec), Num (DefEnumEncoding codec), Monad (MonadEncode codec), Monad (MonadDecode codec), Serializable codec (DefEnumEncoding codec)) => Serializable codec (ViaEnum a)

Defined in Data.SerDoc.Class

Methods

encode :: Proxy codec -> ViaEnum a -> MonadEncode codec ()

decode :: Proxy codec -> MonadDecode codec (ViaEnum a)

Show a => Show (ViaEnum a)

Defined in Data.SerDoc.Class

Methods

showsPrec :: Int -> ViaEnum a -> ShowS

show :: ViaEnum a -> String

showList :: [ViaEnum a] -> ShowS

enumInfo :: forall codec a n. (Typeable a, Show a, Enum a, Bounded a, Codec codec, HasInfo codec n, HasInfo codec (DefEnumEncoding codec)) => Proxy codec -> Proxy a -> Proxy n -> FieldInfo codec

encodeEnum :: forall codec n a. (Enum a, Bounded a, Codec codec, Num n, Serializable codec n) => Proxy codec -> Proxy n -> a -> MonadEncode codec ()

decodeEnum :: forall codec n a. (Enum a, Bounded a, Codec codec, Integral n, Serializable codec n, Monad (MonadDecode codec)) => Proxy codec -> Proxy n -> MonadDecode codec a

getTypeName :: Typeable a => Proxy a -> String

Helpers For Dealing With FieldInfo And 'Field Size'

fieldType :: forall codec. HasInfo codec Word32 => FieldInfo codec -> String

shortFieldType :: FieldInfo codec -> String

infoOf :: String -> FieldInfo codec -> FieldInfo codec

Reduce a FieldInfo to report only the relevant information for a known constructor.

formatPath :: [String] -> String

scopeFieldSize :: String -> FieldSize -> FieldSize

simplifyFieldSize :: FieldSize -> FieldSize

resolveSizeScopes :: forall codec. (Codec codec, HasInfo codec (DefEnumEncoding codec)) => Proxy codec -> Map String [String] -> FieldSize -> FieldSize

fieldSize :: forall codec. (Codec codec, HasInfo codec (DefEnumEncoding codec)) => FieldInfo codec -> FieldSize

fieldSizeScoped :: forall codec. (Codec codec, HasInfo codec (DefEnumEncoding codec)) => [String] -> Map String [String] -> FieldInfo codec -> FieldSize