Data.Serialize.Descriptor

Documentation

newtype Descriptor s a

'Descriptor s a' is an applicative functor that describes the binary structure for a structure s while deserializing value a.

Constructors

Descriptor (Get a, s -> Put)

Instances

Functor (Descriptor s)

Defined in Data.Serialize.Descriptor

Methods

fmap :: (a -> b) -> Descriptor s a -> Descriptor s b

(<$) :: a -> Descriptor s b -> Descriptor s a

Applicative (Descriptor s)

Defined in Data.Serialize.Descriptor

Methods

pure :: a -> Descriptor s a

(<*>) :: Descriptor s (a -> b) -> Descriptor s a -> Descriptor s b

liftA2 :: (a -> b -> c) -> Descriptor s a -> Descriptor s b -> Descriptor s c

(*>) :: Descriptor s a -> Descriptor s b -> Descriptor s b

(<*) :: Descriptor s a -> Descriptor s b -> Descriptor s a

unwrapGet :: Descriptor s a -> Get a

'unwrapGet desc' takes a Descriptor and returns only the internal Get monad.

unwrapPut :: s -> Descriptor s a -> Put

'unwrapPut s desc' takes the structure being described and a Descriptor for it, and returns the internal Put monad.

serialize :: s -> Descriptor s a -> ByteString

Convenience function for 'runPut . unwrapPut s'

deserialize :: ByteString -> Descriptor s s -> Either String s

Convenience function for 'flip runGet bs . unwrapGet'