Ribosome.Host.Handler.Codec

Documentation

class HandlerArg a r where

This class is used by HandlerCodec to decode handler function parameters. Each parameter may consume zero or arbitrarily many of the RPC message's arguments.

Users may create instances for their types to implement custom decoding, especially for commands, since those don't have structured arguments.

See also CommandHandler.

Methods

handlerArg :: [Object] -> Sem r ([Object], a)

Instances

Member (Stop Report) r => HandlerArg ArgList r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], ArgList)

Member (Stop Report) r => HandlerArg Args r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Args)

Member (Stop Report) r => HandlerArg Bang r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Bang)

HandlerArg Bar r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Bar)

(Member (Stop Report) r, MsgpackDecode a) => HandlerArg a r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], a)

(Member (Stop Report) r, FromJSON a) => HandlerArg (JsonArgs a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], JsonArgs a)

(Member (Stop Report) r, OptionParser a) => HandlerArg (Options a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Options a)

HandlerArg a r => HandlerArg (Maybe a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Maybe a)

class HandlerCodec h r | h -> r where

The class of functions that can be converted to canonical RPC handlers of type RpcHandlerFun.

Methods

handlerCodec :: h -> RpcHandlerFun r

Convert a type containing a Sem to a canonicalized RpcHandlerFun by transforming each function parameter with HandlerArg.

Instances

MsgpackEncode a => HandlerCodec (Handler r a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerCodec :: Handler r a -> RpcHandlerFun r

(HandlerArg a (Stop Report ': r), HandlerCodec b r) => HandlerCodec (a -> b) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerCodec :: (a -> b) -> RpcHandlerFun r