Safe Haskell	None
Language	Haskell2010

Servant.JsonRpc

Contents

API specification types
JSON-RPC messages
- Standard error codes
Type rewriting

Description

Work with JSON-RPC protocol messages at both type and value level.

type Mul = JsonRpc "mul" (Int, Int) String Int

req :: Request (Int, Int)
req = Request "mul" (3, 5) (Just 0)

rsp :: JsonRpcResponse String Int
rsp = Result 0 15

Synopsis

data RawJsonRpc api
data JsonRpc (method :: Symbol) p e r
data JsonRpcNotification (method :: Symbol) p
data JSONRPC
data Request p = Request {
- method :: String
- params :: p
- requestId :: Maybe Word64
}
data JsonRpcResponse e r
- = Result Word64 r
- | Ack Word64
- | Errors (Maybe Word64) (JsonRpcErr e)
data JsonRpcErr e = JsonRpcErr {
- errorCode :: Int
- errorMessage :: String
- errorData :: Maybe e
}
parseErrorCode :: Int
invalidRequestCode :: Int
methodNotFoundCode :: Int
invalidParamsCode :: Int
internalErrorCode :: Int
type family JsonRpcEndpoint a where ...

API specification types

data RawJsonRpc api Source #

A JSON RPC server handles any number of methods. Represent this at the type level using this type.

data JsonRpc (method :: Symbol) p e r Source #

JSON-RPC endpoints which respond with a result

data JsonRpcNotification (method :: Symbol) p Source #

JSON-RPC endpoints which do not respond

data JSONRPC Source #

The JSON-RPC content type

Instances

Instances details

Accept JSONRPC Source #
Instance details Defined in Servant.JsonRpc Methods contentType :: Proxy JSONRPC -> MediaType # contentTypes :: Proxy JSONRPC -> NonEmpty MediaType #
ToJSON a => MimeRender JSONRPC a Source #
Instance details Defined in Servant.JsonRpc Methods mimeRender :: Proxy JSONRPC -> a -> ByteString #
FromJSON a => MimeUnrender JSONRPC a Source #
Instance details Defined in Servant.JsonRpc Methods mimeUnrender :: Proxy JSONRPC -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy JSONRPC -> MediaType -> ByteString -> Either String a #

JSON-RPC messages

data Request p Source #

Client messages

Constructors

Request
Fields method :: String params :: p requestId :: Maybe Word64 should be omitted only if the message is a notification, with no response content

Instances

Instances details

Eq p => Eq (Request p) Source #
Instance details Defined in Servant.JsonRpc Methods (==) :: Request p -> Request p -> Bool # (/=) :: Request p -> Request p -> Bool #
Show p => Show (Request p) Source #
Instance details Defined in Servant.JsonRpc Methods showsPrec :: Int -> Request p -> ShowS # show :: Request p -> String # showList :: [Request p] -> ShowS #
ToJSON p => ToJSON (Request p) Source #
Instance details Defined in Servant.JsonRpc Methods toJSON :: Request p -> Value # toEncoding :: Request p -> Encoding # toJSONList :: [Request p] -> Value # toEncodingList :: [Request p] -> Encoding #
FromJSON p => FromJSON (Request p) Source #
Instance details Defined in Servant.JsonRpc Methods parseJSON :: Value -> Parser (Request p) # parseJSONList :: Value -> Parser [Request p] #

data JsonRpcResponse e r Source #

Server messages. An Ack is a message which refers to a Request but both its "errors" and "result" keys are null

Constructors

Result Word64 r
Ack Word64
Errors (Maybe Word64) (JsonRpcErr e)

Instances

Instances details

(Eq r, Eq e) => Eq (JsonRpcResponse e r) Source #
Instance details Defined in Servant.JsonRpc Methods (==) :: JsonRpcResponse e r -> JsonRpcResponse e r -> Bool # (/=) :: JsonRpcResponse e r -> JsonRpcResponse e r -> Bool #
(Show r, Show e) => Show (JsonRpcResponse e r) Source #
Instance details Defined in Servant.JsonRpc Methods showsPrec :: Int -> JsonRpcResponse e r -> ShowS # show :: JsonRpcResponse e r -> String # showList :: [JsonRpcResponse e r] -> ShowS #
(ToJSON e, ToJSON r) => ToJSON (JsonRpcResponse e r) Source #
Instance details Defined in Servant.JsonRpc Methods toJSON :: JsonRpcResponse e r -> Value # toEncoding :: JsonRpcResponse e r -> Encoding # toJSONList :: [JsonRpcResponse e r] -> Value # toEncodingList :: [JsonRpcResponse e r] -> Encoding #
(FromJSON e, FromJSON r) => FromJSON (JsonRpcResponse e r) Source #
Instance details Defined in Servant.JsonRpc Methods parseJSON :: Value -> Parser (JsonRpcResponse e r) # parseJSONList :: Value -> Parser [JsonRpcResponse e r] #

data JsonRpcErr e Source #

Constructors

JsonRpcErr
Fields errorCode :: Int errorMessage :: String errorData :: Maybe e

Instances

Instances details

Eq e => Eq (JsonRpcErr e) Source #
Instance details Defined in Servant.JsonRpc Methods (==) :: JsonRpcErr e -> JsonRpcErr e -> Bool # (/=) :: JsonRpcErr e -> JsonRpcErr e -> Bool #
Show e => Show (JsonRpcErr e) Source #
Instance details Defined in Servant.JsonRpc Methods showsPrec :: Int -> JsonRpcErr e -> ShowS # show :: JsonRpcErr e -> String # showList :: [JsonRpcErr e] -> ShowS #

Standard error codes

parseErrorCode :: Int Source #

invalidRequestCode :: Int Source #

methodNotFoundCode :: Int Source #

invalidParamsCode :: Int Source #

internalErrorCode :: Int Source #

Type rewriting

type family JsonRpcEndpoint a where ... Source #

Equations

JsonRpcEndpoint (JsonRpc m p e r) = ReqBody '[JSONRPC] (Request p) :> Post '[JSONRPC] (JsonRpcResponse e r)
JsonRpcEndpoint (JsonRpcNotification m p) = ReqBody '[JSONRPC] (Request p) :> Post '[JSONRPC] NoContent