Struct ClaudeConfigBuilder 

pub struct ClaudeConfigBuilder { /* private fields */ }

Builder for ClaudeConfig.

Implementations

impl ClaudeConfigBuilder

pub fn preset(self, preset: Preset) -> Self

Sets the preset that determines which CLI flags are auto-injected.

Defaults to Preset::Normal.

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

Sets the path to the claude CLI binary.

When not set, "claude" is resolved via PATH.

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

Sets the model.

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

Sets the system prompt.

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

Sets the append system prompt.

pub fn max_turns(self, max_turns: u32) -> Self

Sets the maximum number of turns.

pub fn timeout(self, timeout: Duration) -> Self

Sets the timeout duration.

pub fn stream_idle_timeout(self, timeout: Duration) -> Self

Sets the idle timeout for streams.

If no event arrives within this duration, the stream yields ClaudeError::Timeout and terminates.

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

Sets the fallback model.

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

Sets the effort level. See effort constants for known values.

pub fn max_budget_usd(self, budget: f64) -> Self

Sets the maximum budget in USD.

pub fn allowed_tools( self, tools: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Sets allowed tools (replaces any previous values).

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

Adds a single allowed tool.

pub fn disallowed_tools( self, tools: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Sets disallowed tools (replaces any previous values).

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

Adds a single disallowed tool.

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

Sets the built-in tool set. "" disables all, "default" enables all.

pub fn mcp_configs( self, configs: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Sets MCP server configs (replaces any previous values).

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

Adds a single MCP server config.

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

Sets the setting sources to load.

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

Sets the path to a settings file or JSON string.

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

Sets the JSON Schema for structured output.

pub fn include_partial_messages(self, enabled: bool) -> Self

Enables or disables partial message chunks in stream output.

pub fn include_hook_events(self, enabled: bool) -> Self

Enables or disables hook events in stream output.

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

Sets the permission mode. See permission_mode constants for known values.

pub fn dangerously_skip_permissions(self, enabled: bool) -> Self

Enables or disables bypassing all permission checks.

pub fn add_dirs(self, dirs: impl IntoIterator<Item = impl Into<String>>) -> Self

Sets additional directories (replaces any previous values).

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

Adds a single additional directory.

pub fn files(self, files: impl IntoIterator<Item = impl Into<String>>) -> Self

Sets file resources (replaces any previous values).

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

Adds a single file resource.

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

Sets the session ID to resume.

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

Sets a specific session ID.

pub fn bare(self, enabled: bool) -> Self

Enables or disables bare/minimal mode.

pub fn no_session_persistence(self, enabled: bool) -> Self

Enables or disables session persistence. Enabled by default; set to false to allow session persistence.

pub fn disable_slash_commands(self, enabled: bool) -> Self

Enables or disables slash commands. Disabled by default; set to false to enable slash commands.

pub fn strict_mcp_config(self, enabled: bool) -> Self

Enables or disables strict MCP config mode. Enabled by default; set to false to allow non---mcp-config MCP servers.

pub fn extra_args( self, args: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Sets arbitrary extra CLI arguments (replaces any previous values).

These are appended before the prompt. Use typed fields when available; duplicating a typed field here may cause unpredictable CLI behavior.

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

Adds a single extra CLI argument.

pub fn build(self) -> ClaudeConfig

Builds the ClaudeConfig.

Trait Implementations

impl Clone for ClaudeConfigBuilder

fn clone(&self) -> ClaudeConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClaudeConfigBuilder

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

Formats the value using the given formatter.

impl Default for ClaudeConfigBuilder

fn default() -> ClaudeConfigBuilder

Returns the “default value” for a type.