Safe Haskell	None
Language	Haskell2010

TypedSession.Codec

Synopsis

newtype Encode role' ps bytes = Encode {
- encode :: forall (send :: role') (recv :: role') (st :: ps) (st' :: ps) (st'' :: ps). Msg role' ps st send st' recv st'' -> bytes
}
newtype Decode role' ps failure bytes = Decode {
- decode :: DecodeStep bytes failure (AnyMsg role' ps)
}
data DecodeStep bytes failure a
- = DecodePartial (Maybe bytes -> DecodeStep bytes failure a)
- | DecodeDone a (Maybe bytes)
- | DecodeFail failure
data CodecFailure
- = CodecFailureOutOfInput
- | CodecFailure String
data Channel (m :: Type -> Type) bytes = Channel {
- send :: bytes -> m ()
- recv :: m (Maybe bytes)
}
runDecoderWithChannel :: Monad m => Channel m bytes -> Maybe bytes -> DecodeStep bytes failure a -> m (Either failure (a, Maybe bytes))

Documentation

newtype Encode role' ps bytes Source #

Function to encode Msg into bytes.

Constructors

Encode
Fields encode :: forall (send :: role') (recv :: role') (st :: ps) (st' :: ps) (st'' :: ps). Msg role' ps st send st' recv st'' -> bytes

newtype Decode role' ps failure bytes Source #

Incremental decoding function.

Constructors

Decode
Fields decode :: DecodeStep bytes failure (AnyMsg role' ps)

data DecodeStep bytes failure a Source #

Generic incremental decoder constructor, you need to convert specific incremental decoders to it.

Constructors

DecodePartial (Maybe bytes -> DecodeStep bytes failure a)
DecodeDone a (Maybe bytes)
DecodeFail failure

Constructors

CodecFailureOutOfInput
CodecFailure String

Instances details

Exception CodecFailure Source #
Instance details Defined in TypedSession.Codec Methods toException :: CodecFailure -> SomeException # fromException :: SomeException -> Maybe CodecFailure # displayException :: CodecFailure -> String # backtraceDesired :: CodecFailure -> Bool #
Show CodecFailure Source #
Instance details Defined in TypedSession.Codec Methods showsPrec :: Int -> CodecFailure -> ShowS # show :: CodecFailure -> String # showList :: [CodecFailure] -> ShowS #
Eq CodecFailure Source #
Instance details Defined in TypedSession.Codec Methods (==) :: CodecFailure -> CodecFailure -> Bool # (/=) :: CodecFailure -> CodecFailure -> Bool #

data Channel (m :: Type -> Type) bytes Source #

Bottom functions for sending and receiving bytes.

Constructors

Channel
Fields send :: bytes -> m () recv :: m (Maybe bytes)

runDecoderWithChannel :: Monad m => Channel m bytes -> Maybe bytes -> DecodeStep bytes failure a -> m (Either failure (a, Maybe bytes)) Source #

Generic incremental decoding function.