README
Tr
Framer
Tr
Reader
Tr
Writer
T
HeaderFramer
T
HeaderReader
T
HeaderWriter
- ::numberID::number
- ::stringID::string
T
LineFramer
T
LineReader
T
LineWriter
- ::as_batch_requestMessage::as_batch_request
- ::as_batch_responseMessage::as_batch_response
- ::as_callMessage::as_call
- ::as_notificationMessage::as_notification
- ::as_requestMessage::as_request
- ::as_responseMessage::as_response
T
RawFramer
T
RawReader
T
RawWriter
T
Request
T
Response
T
WireError
V
header_framer
V
line_framer
V
new_batch_request
V
new_batch_response
V
new_call
V
new_notification
V
new_response
V
raw_framer

jsonrpc2

MoonBit jsonrpc2: provide simple JSON-RPC 2.0 abstractions.

json

json-rpc2

rpc2

Download zip

Author

gmlewis

Version

0.0.30

License

Apache-2.0

Repository

github.com/gmlewis/moonbit-jsonrpc2

Last updated

5 months ago

Downloads

152

gmlewis/io0.23.10

#gmlewis/jsonrpc2

This is a simple abstraction for the JSON-RPC 2.0 specification: https://www.jsonrpc.org/specification based on the Go implementation: https://pkg.go.dev/golang.org/x/exp/jsonrpc2 which has copyright:

// Copyright 2018 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

#Status

The code has been updated to support compiler:

$ moon version --all
moon 0.1.20260512 (81d40e3 2026-05-12) ~/.moon/bin/moon
moonc v0.9.2+bbe2b338f (2026-05-12) ~/.moon/bin/moonc
moonrun 0.1.20260512 (81d40e3 2026-05-12) ~/.moon/bin/moonrun

Framer

source

pub trait Framer {
  reader(Self, &@gmlewis/io.ByteReader
ByteReader) -> &Reader
  writer(Self, &@gmlewis/io.Writer
Writer) -> &Writer
}

Framer wraps low level byte readers and writers into jsonrpc2 message readers and writers. It is responsible for the framing and encoding of messages into wire form.

Reader

source

pub trait Reader {
  read(Self) -> (Message?, Int64, @gmlewis/io.IOError
IOError?)
}

Reader abstracts the transport mechanics from the JSON RPC protocol. A Conn reads messages from the reader it was provided on construction, and assumes that each call to Read fully transfers a single message, or returns an error. A reader is not safe for concurrent use, it is expected it will be used by a single Conn in a safe manner.

Writer

source

pub trait Writer {
  write(Self, Message) -> (Int64, @gmlewis/io.IOError
IOError?)
}

Writer abstracts the transport mechanics from the JSON RPC protocol. A Conn writes messages using the writer it was provided on construction, and assumes that each call to Write fully transfers a single message, or returns an error. A writer is not safe for concurrent use, it is expected it will be used by a single Conn in a safe manner.

HeaderFramer

source

pub struct HeaderFramer {
}

impl Framer for HeaderFramer

HeaderReader

source

pub struct HeaderReader {
  in_ : &@gmlewis/io.ByteReader
ByteReader
}

impl Reader for HeaderReader

HeaderWriter

source

pub struct HeaderWriter {
  out : &@gmlewis/io.Writer
Writer
}

impl Writer for HeaderWriter

ID

source

pub enum ID {
  Number(Int64)
  String(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ID is used to identify the request and tie it to the response.

impl Show for ID

impl ToJson for ID

impl FromJson for ID

ID::number

source

fn ID::number(n : Int64) -> ID

ID::string

source

fn ID::string(s : String) -> ID

LineFramer

source

pub struct LineFramer {
}

impl Framer for LineFramer

LineReader

source

pub struct LineReader {
  in_ : &@gmlewis/io.ByteReader
ByteReader
}

impl Reader for LineReader

LineWriter

source

pub struct LineWriter {
  out : &@gmlewis/io.Writer
Writer
}

impl Writer for LineWriter

Message

source

pub enum Message {
  Request(Request)
  Response(Response)
  BatchRequest(Array[Request])
  BatchResponse(Array[Response])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Message covers all jsonrpc2 message types. They share no common functionality, but are a closed set of concrete types that are allowed to implement this interface. The message types are Request and Response.

impl Show for Message

impl ToJson for Message

impl FromJson for Message

Message::as_batch_request

source

fn Message::as_batch_request(self : Message) -> Array[Request]?

as_batch_request returns the message as a batch request if it is one.

Message::as_batch_response

source

fn Message::as_batch_response(self : Message) -> Array[Response]?

as_batch_response returns the message as a batch response if it is one.

Message::as_call

source

fn Message::as_call(self : Message) -> Request?

Message::as_notification

source

fn Message::as_notification(self : Message) -> Request?

Message::as_request

source

fn Message::as_request(self : Message) -> Request?

Message::as_response

source

fn Message::as_response(self : Message) -> Response?

RawFramer

source

pub struct RawFramer {
}

impl Framer for RawFramer

RawReader

source

type RawReader

impl Reader for RawReader

RawWriter

source

type RawWriter

impl Writer for RawWriter

Request

source

pub(all) struct Request {
  id : ID?
  method_ : String
  params : Json
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A Request is a message sent to a peer to request behavior. If it has an ID then it is a call and therefore requests a response, otherwise it is a notification which receives no response.

impl Show for Request

impl ToJson for Request

impl FromJson for Request

Response

source

pub(all) struct Response {
  id : ID
  result : Result[Json, WireError]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Response is a Message used as a reply to a call Request. It will have the same ID as the call it is a response to.

impl Show for Response

impl ToJson for Response

impl FromJson for Response

WireError

source

pub(all) struct WireError {
  code : Int
  message : String
  data : Json?
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug, @moonbitlang/core/json.FromJson
FromJson)

WireError is a jsonrpc2 error message.

impl Show for WireError

header_framer

source

fn header_framer() -> &Framer

header_framer returns a new Framer. The messages are sent with HTTP content length and MIME type headers. This is the format used by LSP and others.

line_framer

source

fn line_framer() -> &Framer

line_framer returns a new Framer. The messages are sent with a terminating cr+newline, and rely on json decode consistency to determine message boundaries.

new_batch_request

source

fn new_batch_request(messages : Array[Message]) -> Message

new_batch_request constructs a new batch request message for the supplied requests.

new_batch_response

source

fn new_batch_response(messages : Array[Message]) -> Message

new_batch_response constructs a new batch response message for the supplied responses.

new_call

source

fn new_call(id : ID, method_ : String, params : Json) -> Message

new_call constructs a new call message for the supplied ID, method and parameters.

new_notification

source

fn new_notification(method_ : String, params : Json) -> Message

new_notification constructs a new notification message for the supplied method and parameters.

new_response

source

fn new_response(id : ID, result : Result[Json, WireError]) -> Message

new_response constructs a new Response message.

raw_framer

source

fn raw_framer() -> &Framer

raw_framer returns a new Framer. The messages are sent with no wrapping, and rely on json decode consistency to determine message boundaries.

Source Files

Site source Report issue Packages Build queue Skills Statistics

jsonrpc2

#gmlewis/jsonrpc2

#Status

#Framer

#Reader

#Writer

#HeaderFramer

#HeaderReader

#HeaderWriter

#ID

#ID::number

#ID::string

#LineFramer

#LineReader

#LineWriter

#Message

#Message::as_batch_request

#Message::as_batch_response

#Message::as_call

#Message::as_notification

#Message::as_request

#Message::as_response

#RawFramer

#RawReader

#RawWriter

#Request

#Response

#WireError

#header_framer

#line_framer

#new_batch_request

#new_batch_response

#new_call

#new_notification

#new_response

#raw_framer

Source Files

Framer

Reader

Writer

HeaderFramer

HeaderReader

HeaderWriter

ID

ID::number

ID::string

LineFramer

LineReader

LineWriter

Message

Message::as_batch_request

Message::as_batch_response

Message::as_call

Message::as_notification

Message::as_request

Message::as_response

RawFramer

RawReader

RawWriter

Request

Response

WireError

header_framer

line_framer

new_batch_request

new_batch_response

new_call

new_notification

new_response

raw_framer