Servant.JsonRpc

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

API specification types

data RawJsonRpc ctype api

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

JSON-RPC endpoints which respond with a result

data JsonRpcNotification (method :: Symbol) p

JSON-RPC endpoints which do not respond

data JSONRPC

The JSON-RPC content type

Instances

Accept JSONRPC

Defined in Servant.JsonRpc

Methods

contentType :: Proxy JSONRPC -> MediaType

contentTypes :: Proxy JSONRPC -> NonEmpty MediaType

ToJSON a => MimeRender JSONRPC a

Defined in Servant.JsonRpc

Methods

mimeRender :: Proxy JSONRPC -> a -> ByteString

FromJSON a => MimeUnrender JSONRPC a

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

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

FromJSON p => FromJSON (Request p)

Defined in Servant.JsonRpc

Methods

parseJSON :: Value -> Parser (Request p)

parseJSONList :: Value -> Parser [Request p]

omittedField :: Maybe (Request p)

ToJSON p => ToJSON (Request p)

Defined in Servant.JsonRpc

Methods

toJSON :: Request p -> Value

toEncoding :: Request p -> Encoding

toJSONList :: [Request p] -> Value

toEncodingList :: [Request p] -> Encoding

omitField :: Request p -> Bool

Show p => Show (Request p)

Defined in Servant.JsonRpc

Methods

showsPrec :: Int -> Request p -> ShowS

show :: Request p -> String

showList :: [Request p] -> ShowS

Eq p => Eq (Request p)

Defined in Servant.JsonRpc

Methods

(==) :: Request p -> Request p -> Bool

(/=) :: Request p -> Request p -> Bool

data JsonRpcResponse e r

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

(FromJSON e, FromJSON r) => FromJSON (JsonRpcResponse e r)

Defined in Servant.JsonRpc

Methods

parseJSON :: Value -> Parser (JsonRpcResponse e r)

parseJSONList :: Value -> Parser [JsonRpcResponse e r]

omittedField :: Maybe (JsonRpcResponse e r)

(ToJSON e, ToJSON r) => ToJSON (JsonRpcResponse e r)

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

omitField :: JsonRpcResponse e r -> Bool

(Show r, Show e) => Show (JsonRpcResponse e r)

Defined in Servant.JsonRpc

Methods

showsPrec :: Int -> JsonRpcResponse e r -> ShowS

show :: JsonRpcResponse e r -> String

showList :: [JsonRpcResponse e r] -> ShowS

(Eq r, Eq e) => Eq (JsonRpcResponse e r)

Defined in Servant.JsonRpc

Methods

(==) :: JsonRpcResponse e r -> JsonRpcResponse e r -> Bool

(/=) :: JsonRpcResponse e r -> JsonRpcResponse e r -> Bool

data JsonRpcErr e

Constructors

JsonRpcErr

Fields

• errorCode :: Int
• errorMessage :: String
• errorData :: Maybe e

Instances

Show e => Show (JsonRpcErr e)

Defined in Servant.JsonRpc

Methods

showsPrec :: Int -> JsonRpcErr e -> ShowS

show :: JsonRpcErr e -> String

showList :: [JsonRpcErr e] -> ShowS

Eq e => Eq (JsonRpcErr e)

Defined in Servant.JsonRpc

Methods

(==) :: JsonRpcErr e -> JsonRpcErr e -> Bool

(/=) :: JsonRpcErr e -> JsonRpcErr e -> Bool

Standard error codes

parseErrorCode :: Int

invalidRequestCode :: Int

methodNotFoundCode :: Int

invalidParamsCode :: Int

internalErrorCode :: Int

Type rewriting

type family JsonRpcEndpoint ctype a where ...

Equations

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

JsonRpcEndpoint ctype (JsonRpcNotification m p) = ReqBody '[ctype] (Request p) :> Post '[ctype] NoContent