Mokksy/dev.mokksy.mokksy.jsonrpc/JSONRPCResponseBuilder

JSONRPCResponseBuilder

class JSONRPCResponseBuilder<T, E>(source)

DSL builder for constructing JSONRPCResponse instances.

Set either result for a success response or error for a failure response.

Type Parameters

The type of the result value.

The type of the error data.

Example:

val success = jsonRPCResponse<Int> {
    id = RequestId(1)
    result = 42
}

val failure = jsonRPCResponse<Nothing, Nothing> {
    id = RequestId(1)
    error = JSONRPCError.methodNotFound()
}

Constructors

JSONRPCResponseBuilder

constructor()

Properties

error

var error: JSONRPCError<E>?

The error object for a failed response. Mutually exclusive with result.

var id: RequestId?

The request identifier to echo back.

result

var result: T?

The result value for a successful response. Mutually exclusive with error.

Functions

build

fun build(): JSONRPCResponse<T, E>

Builds a JSONRPCResponse from the configured properties.

error

inline fun error(init: JSONRPCErrorBuilder<E>.() -> Unit)

Builds the error inline using the JSONRPCErrorBuilder DSL.