Struct OpencodeClient 

pub struct OpencodeClient { /* private fields */ }

OpenCode API client aligned with official JS SDK request semantics.

Implementations

impl OpencodeClient

pub fn session(&self) -> SessionApi

Returns session endpoint APIs (/session/...).

pub fn app(&self) -> AppApi

Returns app-level endpoint APIs.

pub fn global(&self) -> GlobalApi

Returns global endpoint APIs.

pub fn command(&self) -> CommandApi

Returns command endpoint APIs.

pub fn config(&self) -> ConfigApi

Returns config endpoint APIs.

pub fn project(&self) -> ProjectApi

Returns project endpoint APIs.

pub fn path(&self) -> PathApi

Returns path endpoint APIs.

pub fn file(&self) -> FileApi

Returns file endpoint APIs.

pub fn lsp(&self) -> LspApi

Returns LSP endpoint APIs.

pub fn tool(&self) -> ToolApi

Returns tool endpoint APIs.

pub fn provider(&self) -> ProviderApi

Returns provider endpoint APIs.

pub fn auth(&self) -> AuthApi

Returns auth endpoint APIs.

pub fn mcp(&self) -> McpApi

Returns MCP endpoint APIs.

pub fn pty(&self) -> PtyApi

Returns PTY endpoint APIs.

pub fn event(&self) -> EventApi

Returns event endpoint APIs.

pub fn formatter(&self) -> FormatterApi

Returns formatter endpoint APIs.

pub fn find(&self) -> FindApi

Returns find endpoint APIs.

pub fn instance(&self) -> InstanceApi

Returns instance endpoint APIs.

pub fn vcs(&self) -> VcsApi

Returns VCS endpoint APIs.

pub fn tui(&self) -> TuiApi

Returns TUI endpoint APIs.

pub fn control(&self) -> ControlApi

Backward-compatible shorthand for TUI control endpoints.

pub async fn call_operation( &self, operation_id: &str, options: RequestOptions, ) -> Result<ApiResponse>

Execute any OpenCode operation by official operationId.

pub async fn call_operation_sse( &self, operation_id: &str, options: RequestOptions, ) -> Result<SseStream>

Execute SSE operation by official operationId (global.event / event.subscribe).

pub async fn request_json( &self, method: Method, path_template: &str, options: RequestOptions, ) -> Result<ApiResponse>

Sends one HTTP request and returns a parsed JSON (or text) response envelope.

For 2xx responses:

• 204 or empty body -> {} payload
• valid JSON body -> parsed JSON
• non-JSON body -> string payload

For non-2xx responses, returns Error::Api with status and raw body.

pub async fn request_sse( &self, method: Method, path_template: &str, options: RequestOptions, ) -> Result<SseStream>

Sends one HTTP request and parses the response as Server-Sent Events.

The parser supports:

• split UTF-8 across chunks
• multi-line data: fields
• trailing final lines without a terminating blank line

Trait Implementations

impl Clone for OpencodeClient

fn clone(&self) -> OpencodeClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpencodeClient

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

Formats the value using the given formatter.