Struct OptionsBuilder 

pub struct OptionsBuilder {
    inner: Options,
}

Builder for Options.

Fields

inner: Options

Implementations

impl OptionsBuilder

pub fn new() -> Self

Start from defaults.

pub fn binary(self, binary: impl Into<String>) -> Self

Override the claude binary path or name.

pub fn cwd(self, cwd: impl Into<PathBuf>) -> Self

Set the working directory for the subprocess.

pub fn resume(self, session_id: impl Into<String>) -> Self

Resume an existing session.

pub fn model(self, model: impl Into<String>) -> Self

Override the model.

pub fn permission_mode(self, mode: PermissionMode) -> Self

Set the permission mode.

pub fn can_use_tool<C>(self, callback: C) -> Self

where C: CanUseToolCallback + 'static,

Register a permission callback. Any type implementing CanUseToolCallback works - including plain async functions via the blanket impl.

pub fn auto_approve_tool<F>(self, predicate: F) -> Self

where F: Fn(&str) -> bool + Send + Sync + 'static,

Auto-approve any tool whose name satisfies the predicate. forge-sdk consults this before invoking can_use_tool; the permission flow short-circuits with an allow decision for matches. Caller typically passes a closure that checks mcp__<server>__ prefixes for its in-process MCP servers.

pub fn mcp_server(self, name: impl Into<String>, server: McpServer) -> Self

Register an in-process MCP server under the given name. The model sees tools as mcp__<name>__<tool>.

pub fn hooks(self, hooks: Hooks) -> Self

Attach hooks.

pub fn allowed_tools<I, S>(self, tools: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the --allowedTools list explicitly.

pub fn permission_prompt_tool_name(self, name: impl Into<String>) -> Self

Set an orthogonal permission-prompt tool name (CLI flag --permission-prompt-tool). Alternative to can_use_tool - the CLI invokes the named tool (typically via MCP) instead of routing permission requests to the SDK callback.

pub fn system_prompt(self, sp: SystemPromptKind) -> Self

Set the system prompt.

pub fn max_turns(self, n: u64) -> Self

Cap the turn count.

pub fn session_id(self, id: impl Into<String>) -> Self

Set an explicit session id for a new session (distinct from resume).

pub fn plugins(self, plugins: Vec<SdkPluginConfig>) -> Self

Replace the whole plugin list.

pub fn env(self, k: impl Into<String>, v: impl Into<String>) -> Self

Add one env var to the subprocess environment.

pub fn extra_arg(self, flag: impl Into<String>, value: Option<String>) -> Self

Add one extra argv flag (pass None for bare flags).

pub fn effort(self, e: SubagentEffort) -> Self

Set the reasoning-effort hint.

pub fn tee_inbound(self, cb: impl Fn(&str) + Send + Sync + 'static) -> Self

Attach an inbound wire-tee callback. Receives every stream-json line read from the subprocess stdout (without trailing newline) before the SDK decodes it. Used by forge-test-harness to capture conformance baselines.

pub fn tee_outbound(self, cb: impl Fn(&str) + Send + Sync + 'static) -> Self

Attach an outbound wire-tee callback. Receives every stream-json line about to be written to the subprocess stdin (without trailing newline). Counterpart to tee_inbound.

pub fn build(self) -> Options

Finalise and return the Options.

Trait Implementations

impl Clone for OptionsBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionsBuilder

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

Formats the value using the given formatter.

impl Default for OptionsBuilder

fn default() -> Self

Returns the “default value” for a type.