Struct SessionQuery 

pub struct SessionQuery<'s, 'a> { /* private fields */ }

Builder for a follow-up query within a session.

This wraps a QueryCommand with --resume pre-set. Session-related methods (.continue_session(), .session_id(), .fork_session(), .resume()) are intentionally not exposed, preventing conflicting flags at the type level.

All other QueryCommand options are available via delegation.

Implementations

impl<'s, 'a> SessionQuery<'s, 'a>

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

Set the model to use.

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

Set a custom system prompt.

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

Append to the default system prompt.

pub fn output_format(self, format: OutputFormat) -> Self

Set the output format.

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

Set the maximum budget in USD.

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

Set the permission mode.

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

Add allowed tools.

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

Add a single allowed tool.

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

Add disallowed tools.

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

Add an MCP config file path.

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

Add an additional directory for tool access.

pub fn effort(self, effort: Effort) -> Self

Set the effort level.

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

Set the maximum number of turns.

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

Set a JSON schema for structured output validation.

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

Set a fallback model.

pub fn no_session_persistence(self) -> Self

Disable session persistence.

pub fn dangerously_skip_permissions(self) -> Self

Bypass all permission checks.

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

Set the agent for the session.

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

Set custom agents as a JSON object.

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

Set the list of available built-in tools.

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

Add a file resource to download at startup.

pub fn include_partial_messages(self) -> Self

Include partial message chunks as they arrive.

pub fn input_format(self, format: InputFormat) -> Self

Set the input format.

pub fn strict_mcp_config(self) -> Self

Only use MCP servers from --mcp-config.

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

Path to a settings JSON file or a JSON string.

pub fn retry(self, policy: RetryPolicy) -> Self

Set a per-command retry policy.

pub async fn execute(self) -> Result<QueryResult>

Execute the query, updating the session’s cumulative cost and turns.

Trait Implementations

impl<'s, 'a> Debug for SessionQuery<'s, 'a>

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

Formats the value using the given formatter.