Expand description
QueryEngine - translates QueryEngine.ts from TypeScript Owns the query lifecycle and session state for a conversation.
One QueryEngine per conversation. Each submitMessage() call starts a new turn within the same conversation. State (messages, file cache, usage, etc.) persists across turns.
Structs§
- Abort
Controller - Abort controller
- Agent
Definitions - Always
Allow Rules - AppState
- App state for SDK
- AskConfig
- Configuration for ask function
- Elicitation
Request - Elicitation request
- Elicitation
Response - Elicitation response
- File
State Cache - File state cache
- McpClient
- McpState
- NonNullable
Usage - Token usage (non-nullable)
- Orphaned
Permission - Orphaned permission
- Query
Engine - QueryEngine - owns the query lifecycle and session state
- Query
Engine Config - Query engine configuration (matches TypeScript QueryEngineConfig)
- Query
Tracking - Query tracking for analytics
- SDKPermission
Denial - SDK permission denial
- SDKStatus
- SDK status
- Snip
Result - Snip result from compaction
- Submit
Options - Options for submit_message
- Task
Budget - Task budget configuration
- Thinking
Config - Thinking configuration
- Tool
Permission Context - Tool
UseContext - Tool use context
- Tool
UseContext Options
Enums§
- Permission
Decision - Permission decision
- Permission
Mode - Permission mode enum
- Thinking
Type
Functions§
- ask
- Main ask function - convenience wrapper around QueryEngine Returns a future that resolves to a vector of SDK messages
Type Aliases§
- CanUse
Tool Fn - CanUseTool function type
- Handle
Elicitation Fn - Handle elicitation function type (boxed)
- SDKMessage
- Async generator result type - yields SDK messages
- SetSdk
Status Fn - Set SDK status function type (boxed)
- Snip
Replay Fn - Snip replay function type (boxed)