rpc

README

A minimal JSON-RPC server written directly in Go with no third-party dependencies.

Documentation

Index

• Constants
• func HTTPError(w http.ResponseWriter, statusCode int, err error)
• func UnmarshalParams[T any](data json.RawMessage) (T, error)
• type Error
  • func (err *Error) Error() string
• type Handler
  • func (h *Handler) HTTPHandler(w http.ResponseWriter, r *http.Request)
• type Method
• type Request
  • func UnmarshalRequest(data []byte) (*Request, error)
• type Response
  • func NewResponse(id any, result any, err error) *Response
  • func (r *Response) Marshal() ([]byte, error)

Constants

const JSONRPC_VERSION = "2.0"

Functions

func HTTPError

func HTTPError(w http.ResponseWriter, statusCode int, err error)

func UnmarshalParams

func UnmarshalParams[T any](data json.RawMessage) (T, error)

Types

type Error

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Data    any    `json:"data,omitempty"`
}

func (*Error) Error

func (err *Error) Error() string

type Handler

type Handler struct {
	Methods map[string]Method
}

func (*Handler) HTTPHandler

func (h *Handler) HTTPHandler(w http.ResponseWriter, r *http.Request)

type Method

type Method func(id any, params json.RawMessage) (any, error)

type Request

type Request struct {
	Version string          `json:"jsonrpc"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params,omitempty"`
	Id      any             `json:"id,omitempty"`
}

func UnmarshalRequest

func UnmarshalRequest(data []byte) (*Request, error)

type Response

type Response struct {
	Version string `json:"jsonrpc"`
	Result  any    `json:"result,omitempty"`
	Error   *Error `json:"error,omitempty"`
	Id      any    `json:"id,omitempty"`
}

func NewResponse

func NewResponse(id any, result any, err error) *Response

func (*Response) Marshal

func (r *Response) Marshal() ([]byte, error)