Struct ClaudeAgentOptionsBuilder 

pub struct ClaudeAgentOptionsBuilder { /* private fields */ }

Builder for ClaudeAgentOptions

Implementations

impl ClaudeAgentOptionsBuilder

pub fn new() -> Self

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

pub fn tools_preset(self, preset: ToolsPreset) -> Self

pub fn allowed_tools(self, tools: Vec<String>) -> Self

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

pub fn system_prompt_preset(self, preset: SystemPromptPreset) -> Self

pub fn system_prompt_file(self, file: SystemPromptFile) -> Self

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

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

pub fn mcp_servers(self, servers: HashMap<String, MCPServerConfig>) -> Self

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

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

pub fn continue_conversation(self, continue_conv: bool) -> Self

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

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

pub fn fork_session(self, fork: bool) -> Self

pub fn max_turns(self, turns: i32) -> Self

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

pub fn task_budget(self, budget: TaskBudget) -> Self

pub fn task_budget_total(self, total: i32) -> Self

pub fn disallowed_tools(self, tools: Vec<String>) -> Self

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

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

pub fn betas(self, betas: Vec<SdkBeta>) -> Self

pub fn add_beta(self, beta: SdkBeta) -> Self

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

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

where F: Fn(String, Map<String, Value>, ToolPermissionContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<PermissionResult>> + Send + 'static,

pub fn hook(self, event: impl Into<String>, matcher: HookMatcher) -> Self

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

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

pub fn agents(self, agents: HashMap<String, AgentDefinition>) -> Self

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

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

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

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

pub fn add_dirs(self, dirs: Vec<String>) -> Self

pub fn env(self, env: HashMap<String, String>) -> Self

pub fn env_var(self, key: impl Into<String>, value: impl Into<String>) -> Self

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

pub fn max_buffer_size(self, size: usize) -> Self

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

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

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

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

pub fn setting_sources(self, sources: Vec<SettingSource>) -> Self

pub fn add_setting_source(self, source: SettingSource) -> Self

pub fn skills_all(self) -> Self

pub fn skills(self, skills: Vec<String>) -> Self

pub fn sandbox(self, sandbox: SandboxSettings) -> Self

pub fn plugin(self, plugin: SDKPluginConfig) -> Self

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

pub fn max_thinking_tokens(self, tokens: i32) -> Self

pub fn thinking(self, thinking: ThinkingConfig) -> Self

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

pub fn output_format(self, format: Map<String, Value>) -> Self

pub fn enable_file_checkpointing(self, enable: bool) -> Self

pub fn stderr<F>(self, callback: F) -> Self

where F: Fn(String) + Send + Sync + 'static,

pub fn session_store<S>(self, store: S) -> Self

where S: SessionStore + 'static,

pub fn session_store_handle(self, store: SessionStoreHandle) -> Self

pub fn session_store_flush(self, mode: SessionStoreFlushMode) -> Self

pub fn load_timeout_ms(self, timeout_ms: i32) -> Self

pub fn build(self) -> ClaudeAgentOptions

Trait Implementations

impl Debug for ClaudeAgentOptionsBuilder

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

Formats the value using the given formatter.

impl Default for ClaudeAgentOptionsBuilder

fn default() -> ClaudeAgentOptionsBuilder

Returns the “default value” for a type.