Struct Opencode 

pub struct Opencode { /* private fields */ }

The main OpenCode SDK client.

Holds connection settings and an inner HTTP client. Construct via Opencode::new, Opencode::with_options, or Opencode::builder.

Implementations

impl Opencode

pub fn new() -> Result<Self, OpencodeError>

Create a client with default configuration.

Reads OPENCODE_BASE_URL from the environment; all other settings use the JS SDK defaults (timeout = 60 s, max_retries = 2).

Errors

Returns OpencodeError::Http if the underlying HTTP client cannot be built (e.g. TLS back-end init failure).

pub fn with_options(opts: &ClientOptions) -> Result<Self, OpencodeError>

Create a client from explicit ClientOptions.

Errors

Returns OpencodeError::Http if the underlying HTTP client cannot be built.

pub fn builder() -> OpencodeBuilder

Return an OpencodeBuilder for fluent configuration.

pub fn base_url(&self) -> &str

The resolved base URL.

pub const fn timeout(&self) -> Duration

The per-request timeout.

pub const fn max_retries(&self) -> u32

Maximum automatic retries.

pub const fn default_headers(&self) -> &HeaderMap

Default headers sent with every request.

pub const fn default_query(&self) -> &HashMap<String, String>

Default query parameters appended to every request.

pub const fn app(&self) -> AppResource<'_>

Access the App resource.

pub const fn config(&self) -> ConfigResource<'_>

Access the Config resource.

pub const fn event(&self) -> EventResource<'_>

Access the Event resource.

pub const fn file(&self) -> FileResource<'_>

Access the File resource.

pub const fn find(&self) -> FindResource<'_>

Access the Find resource.

pub const fn session(&self) -> SessionResource<'_>

Access the Session resource.

pub const fn tui(&self) -> TuiResource<'_>

Access the Tui resource.

pub async fn get<T: DeserializeOwned>( &self, path: &str, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

Send a GET request and deserialise the JSON response.

pub async fn get_with_query<T, Q>( &self, path: &str, query: Option<&Q>, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

where T: DeserializeOwned, Q: Serialize + Sync + ?Sized,

Send a GET request with query parameters.

pub async fn post<T, B>( &self, path: &str, body: Option<&B>, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

where T: DeserializeOwned, B: Serialize + Sync,

Send a POST request with an optional JSON body.

pub async fn put<T, B>( &self, path: &str, body: Option<&B>, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

where T: DeserializeOwned, B: Serialize + Sync,

Send a PUT request with an optional JSON body.

pub async fn patch<T, B>( &self, path: &str, body: Option<&B>, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

where T: DeserializeOwned, B: Serialize + Sync,

Send a PATCH request with an optional JSON body.

pub async fn get_stream<T: DeserializeOwned + 'static>( &self, path: &str, ) -> Result<SseStream<T>, OpencodeError>

Send a GET request and return a streaming SSE response.

Unlike other HTTP methods, this does NOT parse the full response body. Instead it returns an crate::SseStream that lazily decodes each SSE event’s data field as JSON of type T.

pub async fn delete<T, B>( &self, path: &str, body: Option<&B>, options: Option<&RequestOptions>, ) -> Result<T, OpencodeError>

where T: DeserializeOwned, B: Serialize + Sync,

Send a DELETE request with an optional JSON body.

Trait Implementations

impl Clone for Opencode

fn clone(&self) -> Opencode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Opencode

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

Formats the value using the given formatter.