Data.Serializer.Example

Simple protocol

data OpCode

OpCode used to differentiate between operations

Constructors

OpCode_Int

OpCode_Bool

Instances

Bounded OpCode

Defined in Data.Serializer.Example

Methods

minBound :: OpCode

maxBound :: OpCode

Enum OpCode

Defined in Data.Serializer.Example

Methods

succ :: OpCode -> OpCode

pred :: OpCode -> OpCode

toEnum :: Int -> OpCode

fromEnum :: OpCode -> Int

enumFrom :: OpCode -> [OpCode]

enumFromThen :: OpCode -> OpCode -> [OpCode]

enumFromTo :: OpCode -> OpCode -> [OpCode]

enumFromThenTo :: OpCode -> OpCode -> OpCode -> [OpCode]

Generic OpCode

Defined in Data.Serializer.Example

Associated Types

type Rep OpCode :: Type -> Type

Methods

from :: OpCode -> Rep OpCode x

to :: Rep OpCode x -> OpCode

Show OpCode

Defined in Data.Serializer.Example

Methods

showsPrec :: Int -> OpCode -> ShowS

show :: OpCode -> String

showList :: [OpCode] -> ShowS

Eq OpCode

Defined in Data.Serializer.Example

Methods

(==) :: OpCode -> OpCode -> Bool

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

Ord OpCode

Defined in Data.Serializer.Example

Methods

compare :: OpCode -> OpCode -> Ordering

(<) :: OpCode -> OpCode -> Bool

(<=) :: OpCode -> OpCode -> Bool

(>) :: OpCode -> OpCode -> Bool

(>=) :: OpCode -> OpCode -> Bool

max :: OpCode -> OpCode -> OpCode

min :: OpCode -> OpCode -> OpCode

type Rep OpCode

Defined in Data.Serializer.Example

type Rep OpCode = D1 ('MetaData "OpCode" "Data.Serializer.Example" "hnix-store-remote-0.7.0.0-3KzMSkqSXnCD71veVOrNoM" 'False) (C1 ('MetaCons "OpCode_Int" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpCode_Bool" 'PrefixI 'False) (U1 :: Type -> Type))

data Cmd :: Type -> Type where

Protocol operations

Constructors

Cmd_Int :: Int8 -> Cmd Int8

Cmd_Bool :: Bool -> Cmd Bool

Instances

TestEquality Cmd

Defined in Data.Serializer.Example

Methods

testEquality :: forall (a :: k) (b :: k). Cmd a -> Cmd b -> Maybe (a :~: b)

GShow Cmd

Defined in Data.Serializer.Example

Methods

gshowsPrec :: forall (a :: k). Int -> Cmd a -> ShowS

Show (Cmd a)

Defined in Data.Serializer.Example

Methods

showsPrec :: Int -> Cmd a -> ShowS

show :: Cmd a -> String

showList :: [Cmd a] -> ShowS

Eq (Cmd a)

Defined in Data.Serializer.Example

Methods

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

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

Arbitrary (Some Cmd)

Defined in Data.Serializer.Example

Methods

arbitrary :: Gen (Some Cmd)

shrink :: Some Cmd -> [Some Cmd]

Eq (Some Cmd)

Defined in Data.Serializer.Example

Methods

(==) :: Some Cmd -> Some Cmd -> Bool

(/=) :: Some Cmd -> Some Cmd -> Bool

Cmd Serializer

cmdS :: forall t. (MonadTrans t, Monad (t Get), Monad (t PutM)) => Serializer t (Some Cmd)

Cmd Serializer

Runners

runG :: Serializer (ExceptT e) a -> ByteString -> Either (GetSerializerError e) a

runGetS specialized to ExceptT e

runP :: Serializer (ExceptT e) a -> a -> Either e ByteString

runPutS specialized to ExceptT e

Custom errors

data MyGetError

Constructors

MyGetError_Example

Instances

Show MyGetError

Defined in Data.Serializer.Example

Methods

showsPrec :: Int -> MyGetError -> ShowS

show :: MyGetError -> String

showList :: [MyGetError] -> ShowS

Eq MyGetError

Defined in Data.Serializer.Example

Methods

(==) :: MyGetError -> MyGetError -> Bool

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

data MyPutError

Constructors

MyPutError_NoLongerSupported

Instances

Show MyPutError

Defined in Data.Serializer.Example

Methods

showsPrec :: Int -> MyPutError -> ShowS

show :: MyPutError -> String

showList :: [MyPutError] -> ShowS

Eq MyPutError

Defined in Data.Serializer.Example

Methods

(==) :: MyPutError -> MyPutError -> Bool

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

Erroring variants of cmdS

putS with throwError and MyPutError

cmdSPutError :: Serializer (ExceptT MyPutError) (Some Cmd)

getS with throwError and MyGetError

cmdSGetError :: Serializer (ExceptT MyGetError) (Some Cmd)

getS with fail

cmdSGetFail :: (MonadTrans t, MonadFail (t Get), Monad (t PutM)) => Serializer t (Some Cmd)

putS with fail

cmdSPutFail :: (MonadTrans t, MonadFail (t PutM), Monad (t Get)) => Serializer t (Some Cmd)

Unused as PutM doesn't have MonadFail >>> serializerPutFail = cmdPutFail @(ExceptT MyGetError) No instance for (MonadFail PutM) as expected

Elaborate

cmdSRest :: Serializer (REST Bool e Int) (Some Cmd)

runGRest :: Serializer (REST r e s) a -> r -> s -> ByteString -> Either (GetSerializerError e) a

runPRest :: Serializer (REST r e s) a -> r -> s -> a -> Either e ByteString