🥮 mooncakes.io

    #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 Proton's private source-built native 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::equal

    source
    fn IpcError::equal(IpcError, IpcError) -> Bool

    IpcError::message

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

    IpcError::not_equal

    source
    fn IpcError::not_equal(x : IpcError, y : IpcError) -> Bool

    IpcError::output

    source
    fn IpcError::output(self : IpcError, logger : &Logger) -> Unit

    IpcError::to_repr

    source

    IpcError::to_string

    source
    fn IpcError::to_string(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::IpcExtensionApi

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

    Creates one remote extension API descriptor.

    IpcExtensionApi::equal

    source

    IpcExtensionApi::from_json

    source

    IpcExtensionApi::not_equal

    source
    fn IpcExtensionApi::not_equal(x : IpcExtensionApi, y : IpcExtensionApi) -> Bool

    IpcExtensionApi::to_json

    source

    IpcExtensionApi::to_repr

    source

    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::IpcExtensionDescriptor

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

    Creates one remote extension bridge descriptor.

    IpcExtensionDescriptor::equal

    source

    IpcExtensionDescriptor::from_json

    source

    IpcExtensionDescriptor::not_equal

    source

    IpcExtensionDescriptor::to_json

    source

    IpcExtensionDescriptor::to_repr

    source

    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::IpcExtensionEvent

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

    Creates one extension event IPC frame.

    IpcExtensionEvent::equal

    source

    IpcExtensionEvent::from_json

    source

    IpcExtensionEvent::not_equal

    source
    fn IpcExtensionEvent::not_equal(x : IpcExtensionEvent, y : IpcExtensionEvent) -> Bool

    IpcExtensionEvent::to_json

    source

    IpcExtensionEvent::to_repr

    source

    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::IpcOpRequest

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

    Creates one operation request frame.

    IpcOpRequest::equal

    source

    IpcOpRequest::from_json

    source

    IpcOpRequest::not_equal

    source
    fn IpcOpRequest::not_equal(x : IpcOpRequest, y : IpcOpRequest) -> Bool

    IpcOpRequest::stringify

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

    Serializes an operation request as one JSON IPC payload.

    IpcOpRequest::to_json

    source

    IpcOpRequest::to_repr

    source

    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::equal

    source

    IpcOpResponse::err

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

    Creates one failed operation response frame.

    IpcOpResponse::from_json

    source

    IpcOpResponse::is_ok

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

    Returns whether this response represents success.

    IpcOpResponse::not_equal

    source
    fn IpcOpResponse::not_equal(x : IpcOpResponse, y : IpcOpResponse) -> Bool

    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::to_json

    source

    IpcOpResponse::to_repr

    source

    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