Struct ClaudeAgentClient 

pub struct ClaudeAgentClient { /* private fields */ }

Implementations

impl ClaudeAgentClient

pub fn spawn_stream_message( options: ClaudeAgentOptions, content: impl Into<UserMessageInput>, ) -> UnboundedReceiver<StreamEvent>

Fire-and-forget streaming for a single prompt.

Spawns a background task that creates a fresh client from options, connects, and streams content, forwarding each StreamEvent to the returned receiver. Unlike Self::stream_message, this returns immediately and the spawned task owns the client for the lifetime of the stream, so the caller only needs to hold the receiver. Connection or streaming failures are surfaced as a final StreamEvent::Error.

Accepts any UserMessageInput: a plain String/&str for text-only prompts, or a Vec<InputContentBlock> to deliver text plus images.

Must be called from within a Tokio runtime.

pub fn spawn_stream_message_supervised( options: ClaudeAgentOptions, content: impl Into<UserMessageInput>, ) -> SpawnedStream

Starts a single-prompt stream with a handle that can await deterministic subprocess cleanup after the consumer drops the event receiver.

pub async fn run_client_stream( client: Self, content: UserMessageInput, tx: UnboundedSender<StreamEvent>, ) -> Result<()>

Runs a prompt against an already constructed client and guarantees the transport is closed before returning. Advanced hosts can use this to retain explicit ownership of spawned-stream shutdown.

pub fn new(options: ClaudeAgentOptions) -> Result<Self>

pub fn with_transport( options: ClaudeAgentOptions, transport: Box<dyn Transport>, ) -> Result<Self>

pub async fn connect(&mut self) -> Result<()>

pub async fn connect_with_prompt( &mut self, content: impl Into<UserMessageInput>, ) -> Result<()>

pub async fn connect_with_stream<S>(&mut self, stream: S) -> Result<()>

where S: Stream<Item = Value> + Unpin,

pub async fn send_message( &mut self, content: impl Into<UserMessageInput>, ) -> Result<MessageResponse>

pub async fn query( &mut self, content: impl Into<UserMessageInput>, ) -> Result<()>

pub async fn query_with_session_id( &mut self, content: impl Into<UserMessageInput>, session_id: impl Into<String>, ) -> Result<()>

pub async fn query_stream<S>(&mut self, stream: S) -> Result<()>

where S: Stream<Item = Value> + Unpin,

pub async fn query_stream_with_session_id<S>( &mut self, stream: S, session_id: impl Into<String>, ) -> Result<()>

where S: Stream<Item = Value> + Unpin,

pub async fn receive_response(&mut self) -> Result<Vec<Message>>

pub async fn receive_messages(&mut self) -> Result<Vec<Message>>

pub async fn stream_message( &mut self, content: impl Into<UserMessageInput>, ) -> Result<UnboundedReceiver<StreamEvent>>

pub async fn get_conversation_history(&self) -> Result<Vec<Message>>

pub async fn abort(&mut self) -> Result<()>

pub async fn disconnect(&mut self) -> Result<()>

pub async fn close(self) -> Result<()>

pub async fn interrupt(&mut self) -> Result<()>

pub async fn set_permission_mode(&mut self, mode: PermissionMode) -> Result<()>

pub async fn set_model(&mut self, model: Option<String>) -> Result<()>

pub async fn rewind_files( &mut self, user_message_id: impl Into<String>, ) -> Result<()>

pub async fn reconnect_mcp_server( &mut self, server_name: impl Into<String>, ) -> Result<()>

pub async fn toggle_mcp_server( &mut self, server_name: impl Into<String>, enabled: bool, ) -> Result<()>

pub async fn stop_task(&mut self, task_id: impl Into<String>) -> Result<()>

pub async fn get_mcp_status(&mut self) -> Result<MCPStatusResponse>

pub async fn get_context_usage(&mut self) -> Result<ContextUsageResponse>

pub fn get_server_info(&self) -> Option<&Map<String, Value>>

Trait Implementations

impl Debug for ClaudeAgentClient

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

Formats the value using the given formatter.