Modulehnix-store-remote-0.7.0.0Haskell2010

Data.Serializer

Serializer ties Get and PutM monads into a single datatype and allows transforming both monads with a monad transformer for adding extra layers like ExceptT (for example when putS can fail due to unsupported version of a protocol) or ReaderT (when we need to serialize a data type based differently based on a protocol version).

See Data.Serializer.Example

5 types
11 values

Packagehnix-store-remote-0.7.0.0
Exports16
LanguageHaskell2010
LicenceApache-2.0
SourceSerializer.hs

Serializer

1 declaration

datadata Serializer (t :: (Type -> Type) -> Type -> Type) a

Serializer ties Get and PutM monads into a single datatype and allows transforming the monads with a monad transformer for e.g. adding ExceptT or ReaderT layers.

Constructors

Serializer
- getS :: t Get a
- putS :: a -> t PutM ()

Runners

valuerunGetS

:: (Monad (t Get), MonadTrans t)
=> Serializer t a
Serializer
-> (t Get a -> Get b)
Tranformer runner
-> ByteString
ByteString to parse
-> Either String b

Runner for getS of Serializer

valuerunPutS

:: (Monad (t PutM), MonadTrans t)
=> Serializer t a
Serializer
-> (t PutM () -> PutM b)
Tranformer runner
-> a
Value to (out)put
-> (b, ByteString)

Runner for putS of Serializer

Simple serializer

1 declaration

typetype SimpleSerializer a = Serializer IdentityT a

Simple Serializer

Simple runners

valuerunGetSimple :: SimpleSerializer a -> ByteString -> Either String a

Runner for getS of SimpleSerializer

valuerunPutSimple :: SimpleSerializer a -> a -> ByteString

Runner for putS of SimpleSerializer

From Get/Put, Serialize

2 declarations

valuelift2 :: MonadTrans t => Get a -> Putter a -> Serializer t a

Lift Get a and Putter a into Serializer

valueliftSerialize :: (Serialize a, MonadTrans t) => Serializer t a

Lift Serialize a instance into Serializer

Combinators

3 declarations

valuemapIsoSerializer

:: Functor (t Get)
=> (a -> b)
Map over getS
-> (b -> a)
Map over putS
-> Serializer t a
-> Serializer t b

Map over Serializer

valuemapPrismSerializer

:: MonadError eGet (t Get)
=> (a -> Either eGet b)
Map over getS
-> (b -> a)
Map over putS
-> Serializer t a
-> Serializer t b

Map over Serializer where getS can return Either

valuetup

:: (Applicative (t Get), Monad (t PutM))
=> Serializer t a
-> Serializer t b
-> Serializer t (a, b)

Tuple combinator

Utility

3 declarations

datadata GetSerializerError customGetError

Wrapper for both GetS errors

the one that occurs when fail is called
custom one when ExceptT is used

Constructors

SerializerError_GetFail String
SerializerError_Get customGetError

Instances3Eq, Ord, Show

Eq customGetError => Eq (GetSerializerError customGetError)Defined in hnix-store-remote-0.7.0.0 · Data.Serializer
Ord customGetError => Ord (GetSerializerError customGetError)Defined in hnix-store-remote-0.7.0.0 · Data.Serializer
Show customGetError => Show (GetSerializerError customGetError)Defined in hnix-store-remote-0.7.0.0 · Data.Serializer

valuetransformGetError

:: Either String (Either customGetError b)
-> Either (GetSerializerError customGetError) b

Helper for transforming nested Eithers into GetSerializerError wrapper

valuetransformPutError

:: (Either customPutError (), ByteString)
-> Either customPutError ByteString

Helper for transforming runPutM result

Re-exports

2 declarations

newtypenewtype Get a

The Get monad is an Exception and State monad.

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Functor GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
MonadFail GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Applicative GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Alternative GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
MonadPlus GetDefined in cereal-0.5.8.3 · Data.Serialize.Get

newtypenewtype PutM a

The PutM type. A Writer monad over the efficient Builder monoid.

Instances5Monad, Functor, Applicative, Semigroup, Monoid

Monad PutMDefined in cereal-0.5.8.3 · Data.Serialize.Put
Functor PutMDefined in cereal-0.5.8.3 · Data.Serialize.Put
Applicative PutMDefined in cereal-0.5.8.3 · Data.Serialize.Put
Semigroup (PutM ())Defined in cereal-0.5.8.3 · Data.Serialize.Put
Monoid (PutM ())Defined in cereal-0.5.8.3 · Data.Serialize.Put