Enum Transport 

#[non_exhaustive]
pub enum Transport {
    Default,
    Stdio,
    InProcess,
    Tcp {
        port: u16,
        connection_token: Option<String>,
    },
    External {
        host: String,
        port: u16,
        connection_token: Option<String>,
    },
}

How the SDK communicates with the CLI server.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

Resolve the transport from COPILOT_SDK_DEFAULT_CONNECTION, falling back to Transport::Stdio when the variable is unset.

Stdio

Communicate over stdin/stdout pipes (default).

InProcess

Host the runtime in-process over FFI (no child process).

Loads the native runtime library next to the resolved CLI entrypoint and speaks JSON-RPC over its C ABI. The runtime spawns its own worker; the SDK never launches a CLI child process. This is experimental. Per-client ClientOptions::working_directory, ClientOptions::env/ClientOptions::env_remove, ClientOptions::telemetry, and ClientOptions::github_token are not supported because native runtime code shares the host process. ClientOptions::base_directory remains supported because it is passed to the spawned worker as COPILOT_HOME.

Requires the bundled-in-process Cargo feature.

Tcp

Spawn the CLI with --port and connect via TCP.

Fields

port: u16

Port to listen on (0 for OS-assigned).

connection_token: Option<String>

Optional connection token. When None and the SDK is spawning the CLI, the SDK auto-generates a 128-bit hex token so the loopback listener is safe by default.

External

Connect to an already-running CLI server (no process spawning).

Fields

host: String

Hostname or IP of the running server.

port: u16

Port of the running server.

connection_token: Option<String>

Optional connection token. Required when the external server was started with a token, ignored otherwise.

Trait Implementations

impl Debug for Transport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Transport

fn default() -> Transport

Returns the “default value” for a type.