Moduletyped-protocols-1.2.2.0

Network.TypedProtocol.Codec

13 types
2 classes
11 values

Packagetyped-protocols-1.2.2.0
Exports28
LicenceApache-2.0

valuehoistAnnotation

:: Functor m
=> forall (st :: ps). f st -> g st
-> CodecF ps failure m f bytes
-> CodecF ps failure m g bytes

valuehoistCodec

:: Functor n
=> forall x. m x -> n x
-> CodecF ps failure m f bytes
-> CodecF ps failure n f bytes

valuehoistDecodeStep

:: Functor n
=> forall x. m x -> n x
-> DecodeStep bytes failure m a
-> DecodeStep bytes failure n a

valueisoCodec

:: Functor m
=> bytes -> bytes'
-> bytes' -> bytes
-> CodecF ps failure m f bytes
-> CodecF ps failure m f bytes'

valueisoDecodeStep

:: Functor m
=> bytes -> bytes'
-> bytes' -> bytes
-> DecodeStep bytes failure m a
-> DecodeStep bytes' failure m a

valuemapFailureCodec

:: Functor m
=> failure -> failure'
-> CodecF ps failure m f bytes
-> CodecF ps failure' m f bytes

valuemapFailureDecodeStep

:: Functor m
=> failure -> failure'
-> DecodeStep bytes failure m a
-> DecodeStep bytes failure' m a

valuerunDecoder

:: Monad m
=> [bytes]
-> DecodeStep bytes failure m a
-> m (Either failure a)

valuerunDecoderPure

:: Monad m
=> forall b. m b -> b
-> m (DecodeStep bytes failure m a)
-> [bytes]
-> Either failure a

valueunAnnotateCodec

:: (Functor m, Monoid bytes)
=> AnnotatedCodec ps failure m bytes
-> Codec ps failure m bytes

valuenotActiveState

:: (StateAgency st ~ 'NobodyAgency, ActiveState st)
=> StateToken st
-> forall a. a

typetype AnnotatedCodec ps failure (m :: Type -> Type) bytes = CodecF ps failure m (Annotator bytes) bytes

newtypenewtype Annotator bytes (st :: ps)

Constructors

Annotator
- runAnnotator :: bytes -> SomeMessage st

datadata AnyMessage ps where

Constructors

AnyMessage :: (StateTokenI st, ActiveState st) => Message ps st st' -> AnyMessage ps

Instances1Show

(forall (st :: ps) (st' :: ps). Show (Message ps st st')) => Show (AnyMessage ps)Defined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec

pattern

pattern AnyMessageAndAgency :: () => (StateTokenI st, ActiveState st) => StateToken st -> Message ps st st' -> AnyMessage ps

typetype Codec ps failure (m :: Type -> Type) bytes = CodecF ps failure m SomeMessage bytes

datadata CodecF ps failure (m :: Type -> Type) (f :: ps -> Type) bytes

Constructors

Codec
- encode :: forall (st :: ps) (st' :: ps). (StateTokenI st, ActiveState st) => Message ps st st' -> bytes
- decode :: forall (st :: ps). ActiveState st => StateToken st -> m (DecodeStep bytes failure m (f st))

datadata CodecFailure

Constructors

CodecFailureOutOfInput
CodecFailure String

Instances4Eq, Show, Exception, NFData

Eq CodecFailureDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec
Show CodecFailureDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec
Exception CodecFailureDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec
NFData CodecFailureDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec

datadata DecodeStep bytes failure (m :: Type -> Type) a

Constructors

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

Instances1Functor

Functor m => Functor (DecodeStep bytes failure m)Defined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Codec

datadata SomeState ps where

Constructors

SomeState :: ActiveState st => StateToken st -> SomeState ps

typetype ActiveAgency (st :: ps) = ActiveAgency' st (StateAgency st)

datadata ActiveAgency' (st :: ps) (agency :: Agency) where

Constructors

ClientHasAgency :: StateAgency st ~ 'ClientAgency => ActiveAgency' st 'ClientAgency
ServerHasAgency :: StateAgency st ~ 'ServerAgency => ActiveAgency' st 'ServerAgency

Instances1Show

Show (ActiveAgency' st agency)Defined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core

typetype ActiveState (st :: ps) = IsActiveState st (StateAgency st)

classclass IsActiveState (st :: ps) (agency :: Agency) where

Methods

activeAgency :: ActiveAgency' st agency

Instances2IsActiveState

'ClientAgency ~ StateAgency st => IsActiveState st 'ClientAgencyDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core
'ServerAgency ~ StateAgency st => IsActiveState st 'ServerAgencyDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core

datadata PeerRole

AsClient AsServer

Instances3SingI, Sing

SingI 'AsClientDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core
SingI 'AsServerDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core
type Sing = SingPeerRoleDefined in typed-protocols-1.2.2.0 · Network.TypedProtocol.Core

familytype family StateToken :: ps -> Type

classclass StateTokenI (st :: ps) where

Methods

stateToken :: StateToken st

datadata SomeMessage (st :: ps) where

Constructors

SomeMessage :: (StateTokenI st, StateTokenI st', ActiveState st) => Message ps st st' -> SomeMessage st