Struct ThreadOptions 

pub struct ThreadOptions {

    pub working_directory: Option<PathBuf>,
    pub model: Option<String>,
    pub sandbox: SandboxPolicy,
    pub approval: ApprovalPolicy,
    pub additional_directories: Vec<PathBuf>,
    pub skip_git_repo_check: bool,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub network_access: Option<bool>,
    pub web_search: Option<WebSearchMode>,
    pub output_schema: Option<OutputSchema>,
    pub ephemeral: bool,
    pub images: Vec<PathBuf>,
    pub local_provider: Option<String>,
    pub system_prompt: Option<String>,
    pub max_turns: Option<u32>,
    pub max_budget_tokens: Option<u64>,
    pub mcp_servers: McpServers,
    pub hooks: Vec<HookMatcher>,
    pub default_hook_timeout: Duration,
}

Options for a single thread (conversation).

Fields

working_directory: Option<PathBuf>

Working directory for the thread.

model: Option<String>

Model to use (e.g., “gpt-5-codex”, “o4-mini”).

sandbox: SandboxPolicy

Sandbox policy.

approval: ApprovalPolicy

Approval policy.

additional_directories: Vec<PathBuf>

Additional writable directories (passed via --add-dir).

skip_git_repo_check: bool

Skip git repository check.

reasoning_effort: Option<ReasoningEffort>

Reasoning effort level.

network_access: Option<bool>

Enable network access in sandbox.

web_search: Option<WebSearchMode>

Web search mode.

output_schema: Option<OutputSchema>

JSON Schema for structured output.

ephemeral: bool

Ephemeral mode — don’t persist session to disk.

images: Vec<PathBuf>

Image file paths to include with the prompt.

local_provider: Option<String>

Use local/OSS provider (lmstudio, ollama).

system_prompt: Option<String>

System prompt override — passed to CLI via -c system_prompt="...".

max_turns: Option<u32>

SDK-enforced maximum number of turns. The stream closes after this many TurnCompleted events.

max_budget_tokens: Option<u64>

SDK-enforced token budget. The stream closes when cumulative Usage.output_tokens exceeds this value.

mcp_servers: McpServers

MCP server configurations. Serialized to CLI config overrides.

hooks: Vec<HookMatcher>

Hook matchers — evaluated in order on each stream event.

default_hook_timeout: Duration

Default timeout for hook callbacks (applied when HookMatcher.timeout is None).

Implementations

impl ThreadOptions

pub fn builder() -> ThreadOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building ThreadOptions. On the builder, call .working_directory(...)(optional), .model(...)(optional), .sandbox(...)(optional), .approval(...)(optional), .additional_directories(...)(optional), .skip_git_repo_check(...)(optional), .reasoning_effort(...)(optional), .network_access(...)(optional), .web_search(...)(optional), .output_schema(...)(optional), .ephemeral(...)(optional), .images(...)(optional), .local_provider(...)(optional), .system_prompt(...)(optional), .max_turns(...)(optional), .max_budget_tokens(...)(optional), .mcp_servers(...)(optional), .hooks(...)(optional), .default_hook_timeout(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ThreadOptions.

impl ThreadOptions

pub fn to_cli_args(&self) -> Vec<String>

Convert thread options to CLI arguments for codex exec.

Trait Implementations

impl Clone for ThreadOptions

fn clone(&self) -> ThreadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadOptions

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

Formats the value using the given formatter.

impl Default for ThreadOptions

fn default() -> Self

Returns the “default value” for a type.