🥮 mooncakes.io
README

#proton/ipc

moonbit-community/proton/ipc defines transport-neutral protocol types for Proton.

It does not know about WebView, WebSocket, process launch, or extension code. The current root facade uses these types with the native DLL bridge.

#
IpcError

source
pub(all) suberror IpcError {
  MalformedJson(detail~ : String)
  InvalidPayload(kind~ : String, detail~ : String)
  UnsupportedVersion(scope~ : String, actual~ : Int, supported~ : Int)
  EmptyField(path~ : String)
  InvalidErrorResponseBody
} derive(Eq, 
Debug)

Failures while decoding or validating Proton IPC protocol values.

#
IpcError::message

source
fn IpcError::message(self : IpcError) -> String

#
IpcExtensionApi

source
pub(all) struct IpcExtensionApi {
  api_name : String
} derive(Eq, ToJson, 
Debug, 
FromJson)

One JavaScript-facing API exposed for a remote extension namespace.

#
IpcExtensionApi::new

source
fn IpcExtensionApi::new(api_name : String) -> IpcExtensionApi

Creates one remote extension API descriptor.

#
IpcExtensionDescriptor

source
pub(all) struct IpcExtensionDescriptor {
  id : String
  js_namespace : String
  apis : Array[IpcExtensionApi]
  scripts : Array[String]
} derive(Eq, ToJson, 
Debug, 
FromJson)

JavaScript bridge metadata for one remote extension.

#
IpcExtensionDescriptor::new

source
fn IpcExtensionDescriptor::new(id : String, js_namespace : String, apis : Array[IpcExtensionApi], scripts? : Array[String]) -> IpcExtensionDescriptor

Creates one remote extension bridge descriptor.

#
IpcExtensionEvent

source
pub(all) struct IpcExtensionEvent {
  version : Int
  extension_namespace : String
  event_name : String
  payload : Json
} derive(Eq, ToJson, 
Debug, 
FromJson)

One extension event sent from the user process to JavaScript.

#
IpcExtensionEvent::new

source
fn IpcExtensionEvent::new(extension_namespace : String, event_name : String, payload : Json) -> IpcExtensionEvent

Creates one extension event IPC frame.

#
IpcExtensionEvent::validate

source

Validates one decoded extension event.

#
IpcOpRequest

source
pub(all) struct IpcOpRequest {
  version : Int
  id : String
  name : String
  payload : Json
} derive(Eq, ToJson, 
Debug, 
FromJson)

One operation invocation sent from the JavaScript bridge to the user process.

#
IpcOpRequest::new

source
fn IpcOpRequest::new(id : String, name : String, payload : Json) -> IpcOpRequest

Creates one operation request frame.

#
IpcOpRequest::stringify

source
fn IpcOpRequest::stringify(self : IpcOpRequest) -> String

Serializes an operation request as one JSON IPC payload.

#
IpcOpRequest::validate

source
fn IpcOpRequest::validate(self : IpcOpRequest) -> IpcOpRequest raise IpcError

Validates one decoded operation request.

#
IpcOpResponse

source
pub(all) struct IpcOpResponse {
  version : Int
  id : String
  status : Int
  body : Json
} derive(Eq, ToJson, 
Debug, 
FromJson)

One operation completion sent from the user process back to JavaScript.

status == 0 means success. Any non-zero status means body contains a JSON string error message suitable for rejecting the JavaScript promise.

#
IpcOpResponse::err

source
fn IpcOpResponse::err(id : String, message : String) -> IpcOpResponse

Creates one failed operation response frame.

#
IpcOpResponse::is_ok

source
fn IpcOpResponse::is_ok(self : IpcOpResponse) -> Bool

Returns whether this response represents success.

#
IpcOpResponse::ok

source
fn IpcOpResponse::ok(id : String, body : Json) -> IpcOpResponse

Creates one successful operation response frame.

#
IpcOpResponse::stringify

source
fn IpcOpResponse::stringify(self : IpcOpResponse) -> String

Serializes an operation response as one JSON IPC payload.

#
IpcOpResponse::validate

source
fn IpcOpResponse::validate(self : IpcOpResponse) -> IpcOpResponse raise IpcError

Validates one decoded operation response.

#
parse_ipc_op_request

source
fn parse_ipc_op_request(raw : String) -> IpcOpRequest raise IpcError

Parses one JSON IPC operation request.

#
parse_ipc_op_response

source
fn parse_ipc_op_response(raw : String) -> IpcOpResponse raise IpcError

Parses one JSON IPC operation response.

#
protocol_version

source
fn protocol_version() -> Int

Returns the protocol version used in all IPC envelopes and payloads.

Source Files

Powered by MoonBit

Site sourceReport issuePackagesBuild queueSkillsStatistics

© 2026 mooncakes.io