Skip to main content

Module protocol

Module protocol 

Source
Expand description

Preview command protocol types.

This module defines the messages exchanged between:

  • CLI → Preview support app (render commands via TCP)
  • Preview support app → CLI (render results via TCP)

Structs§

AppOutput
Successful render output.
DylibId
Stable identifier for a preview dylib payload.
PreviewProtocolInfo
Protocol metadata exchanged during ping/pong handshake.
PreviewTcpConfig
TCP configuration shared by the CLI and preview app.
Size
Frame size for rendering.

Enums§

AppError
Errors that can occur during preview rendering.
AppRequest
Request from CLI to preview support app.
AppResponse
Response from preview support app.
DylibSource
How to provide the dylib used for rendering.
PreviewPlatform
Target platform for a native preview support app.
PreviewRuntimePlatform
Runtime platform that owns the preview support app process.

Constants§

PREVIEW_PROTOCOL_COMMIT
Build commit hash for protocol compatibility checks.

Functions§

function_path_to_symbol
Convert a function path to preview export symbol.