Skip to main content

OpenCodeConfigBuilder

Struct OpenCodeConfigBuilder 

Source
pub struct OpenCodeConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> OpenCodeConfigBuilder<S>

Source

pub fn build(self) -> OpenCodeConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn execution_mode( self, value: OpenCodeExecutionMode, ) -> OpenCodeConfigBuilder<SetExecutionMode<S>>
where S::ExecutionMode: IsUnset,

Optional (Some / Option setters). Default: <OpenCodeExecutionMode as Default>::default().

Execution path. Agent mode launches opencode serve.

Source

pub fn maybe_execution_mode( self, value: Option<OpenCodeExecutionMode>, ) -> OpenCodeConfigBuilder<SetExecutionMode<S>>
where S::ExecutionMode: IsUnset,

Optional (Some / Option setters). Default: <OpenCodeExecutionMode as Default>::default().

Execution path. Agent mode launches opencode serve.

Source

pub fn api_key( self, value: impl Into<String>, ) -> OpenCodeConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key for bearer auth. Falls back to OPENCODE_ZEN_KEY / OPENCODE_API_KEY env vars.

Source

pub fn maybe_api_key( self, value: Option<impl Into<String>>, ) -> OpenCodeConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key for bearer auth. Falls back to OPENCODE_ZEN_KEY / OPENCODE_API_KEY env vars.

Source

pub fn provider( self, value: OpenCodeProvider, ) -> OpenCodeConfigBuilder<SetProvider<S>>
where S::Provider: IsUnset,

Optional (Some / Option setters). Default: <OpenCodeProvider as Default>::default().

Provider selection.

Source

pub fn maybe_provider( self, value: Option<OpenCodeProvider>, ) -> OpenCodeConfigBuilder<SetProvider<S>>
where S::Provider: IsUnset,

Optional (Some / Option setters). Default: <OpenCodeProvider as Default>::default().

Provider selection.

Source

pub fn timeout_secs( self, value: u64, ) -> OpenCodeConfigBuilder<SetTimeoutSecs<S>>
where S::TimeoutSecs: IsUnset,

Optional (Some / Option setters). HTTP request timeout in seconds.

Source

pub fn maybe_timeout_secs( self, value: Option<u64>, ) -> OpenCodeConfigBuilder<SetTimeoutSecs<S>>
where S::TimeoutSecs: IsUnset,

Optional (Some / Option setters). HTTP request timeout in seconds.

Source

pub fn startup_timeout_secs( self, value: u64, ) -> OpenCodeConfigBuilder<SetStartupTimeoutSecs<S>>
where S::StartupTimeoutSecs: IsUnset,

Optional (Some / Option setters). Maximum time to wait for opencode serve to become ready in agent mode.

Source

pub fn maybe_startup_timeout_secs( self, value: Option<u64>, ) -> OpenCodeConfigBuilder<SetStartupTimeoutSecs<S>>
where S::StartupTimeoutSecs: IsUnset,

Optional (Some / Option setters). Maximum time to wait for opencode serve to become ready in agent mode.

Source

pub fn max_retries(self, value: u32) -> OpenCodeConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Maximum retry attempts for transient errors (429, 5xx).

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> OpenCodeConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Maximum retry attempts for transient errors (429, 5xx).

Source

pub fn max_tokens(self, value: u32) -> OpenCodeConfigBuilder<SetMaxTokens<S>>
where S::MaxTokens: IsUnset,

Optional (Some / Option setters). Maximum tokens in the completion response.

Source

pub fn maybe_max_tokens( self, value: Option<u32>, ) -> OpenCodeConfigBuilder<SetMaxTokens<S>>
where S::MaxTokens: IsUnset,

Optional (Some / Option setters). Maximum tokens in the completion response.

Source

pub fn temperature(self, value: f32) -> OpenCodeConfigBuilder<SetTemperature<S>>
where S::Temperature: IsUnset,

Optional (Some / Option setters). Sampling temperature.

Source

pub fn maybe_temperature( self, value: Option<f32>, ) -> OpenCodeConfigBuilder<SetTemperature<S>>
where S::Temperature: IsUnset,

Optional (Some / Option setters). Sampling temperature.

Source

pub fn stream(self, value: bool) -> OpenCodeConfigBuilder<SetStream<S>>
where S::Stream: IsUnset,

Optional (Some / Option setters). Default: true.

Enable SSE streaming responses.

Source

pub fn maybe_stream( self, value: Option<bool>, ) -> OpenCodeConfigBuilder<SetStream<S>>
where S::Stream: IsUnset,

Optional (Some / Option setters). Default: true.

Enable SSE streaming responses.

Source

pub fn mcp_servers( self, value: Vec<OpenCodeMcpServer>, ) -> OpenCodeConfigBuilder<SetMcpServers<S>>
where S::McpServers: IsUnset,

Optional (Some / Option setters). Default: <Vec<OpenCodeMcpServer> as Default>::default().

MCP servers to register with the OpenCode agent.

Source

pub fn maybe_mcp_servers( self, value: Option<Vec<OpenCodeMcpServer>>, ) -> OpenCodeConfigBuilder<SetMcpServers<S>>
where S::McpServers: IsUnset,

Optional (Some / Option setters). Default: <Vec<OpenCodeMcpServer> as Default>::default().

MCP servers to register with the OpenCode agent.

Source

pub fn mcp_config_mode( self, value: McpConfigMode, ) -> OpenCodeConfigBuilder<SetMcpConfigMode<S>>
where S::McpConfigMode: IsUnset,

Optional (Some / Option setters). Default: <McpConfigMode as Default>::default().

Controls whether Chimera MCP servers are merged with ambient OpenCode config or launched in an isolated explicit-only config environment.

Source

pub fn maybe_mcp_config_mode( self, value: Option<McpConfigMode>, ) -> OpenCodeConfigBuilder<SetMcpConfigMode<S>>
where S::McpConfigMode: IsUnset,

Optional (Some / Option setters). Default: <McpConfigMode as Default>::default().

Controls whether Chimera MCP servers are merged with ambient OpenCode config or launched in an isolated explicit-only config environment.

Source

pub fn agent_base_url( self, value: impl Into<String>, ) -> OpenCodeConfigBuilder<SetAgentBaseUrl<S>>
where S::AgentBaseUrl: IsUnset,

Optional (Some / Option setters). Override the selected OpenCode provider’s base URL in agent mode.

Source

pub fn maybe_agent_base_url( self, value: Option<impl Into<String>>, ) -> OpenCodeConfigBuilder<SetAgentBaseUrl<S>>
where S::AgentBaseUrl: IsUnset,

Optional (Some / Option setters). Override the selected OpenCode provider’s base URL in agent mode.

Source

pub fn session_title( self, value: impl Into<String>, ) -> OpenCodeConfigBuilder<SetSessionTitle<S>>
where S::SessionTitle: IsUnset,

Optional (Some / Option setters). Initial title for sessions created in agent mode.

A fixed title suppresses OpenCode’s asynchronous title-generation turn.

Source

pub fn maybe_session_title( self, value: Option<impl Into<String>>, ) -> OpenCodeConfigBuilder<SetSessionTitle<S>>
where S::SessionTitle: IsUnset,

Optional (Some / Option setters). Initial title for sessions created in agent mode.

A fixed title suppresses OpenCode’s asynchronous title-generation turn.

Source

pub fn system_prompt( self, value: impl Into<String>, ) -> OpenCodeConfigBuilder<SetSystemPrompt<S>>
where S::SystemPrompt: IsUnset,

Optional (Some / Option setters). System prompt override passed to the agent session.

Source

pub fn maybe_system_prompt( self, value: Option<impl Into<String>>, ) -> OpenCodeConfigBuilder<SetSystemPrompt<S>>
where S::SystemPrompt: IsUnset,

Optional (Some / Option setters). System prompt override passed to the agent session.

Source

pub fn variant( self, value: impl Into<String>, ) -> OpenCodeConfigBuilder<SetVariant<S>>
where S::Variant: IsUnset,

Optional (Some / Option setters). Provider/model variant name (for example reasoning presets like medium or high).

Source

pub fn maybe_variant( self, value: Option<impl Into<String>>, ) -> OpenCodeConfigBuilder<SetVariant<S>>
where S::Variant: IsUnset,

Optional (Some / Option setters). Provider/model variant name (for example reasoning presets like medium or high).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more