ctypes

Documentation

Index

• Constants
• type Error
  • func (e Error) Error() string
• type ErrorCode
• type ID
• type Method
• type Request
• type Response

Constants

const Version = "1"

Types

type Error

type Error struct {
	Code    ErrorCode `json:"code"`
	Message string    `json:"message"`
}

Error is an RPC error payload.

func (Error) Error

func (e Error) Error() string

Error returns a readable error string.

type ErrorCode

type ErrorCode int

ErrorCode is a numeric service error code.

const DefaultErrorCode ErrorCode = 666

type ID

type ID string

ID is a request identifier.

type Method

type Method string

Method is an RPC method name.

type Request

type Request struct {
	Version string          `json:"lrpc"` //nolint:tagliatelle
	ID      ID              `json:"id"`
	Params  json.RawMessage `json:"params"`
}

Request is a common RPC request body.

type Response

type Response[T any] struct {
	Version string `json:"lrpc"` //nolint:tagliatelle
	ID      ID     `json:"id"`
	Error   *Error `json:"error,omitempty"`
	Result  T      `json:"result,omitempty"`
}

Response is a common RPC response body.