Struct ClaudeSDKClient

pub struct ClaudeSDKClient { /* private fields */ }

Interactive client for bidirectional communication with Claude

ClaudeSDKClient provides a stateful, interactive interface for communicating with Claude Code CLI. Unlike the simple query function, this client supports:

• Bidirectional communication
• Multiple sessions
• Interrupt capabilities
• State management
• Follow-up messages based on responses

Example

use cc_sdk::{ClaudeSDKClient, ClaudeCodeOptions, Message, Result};
use futures::StreamExt;

#[tokio::main]
async fn main() -> Result<()> {
    let options = ClaudeCodeOptions::builder()
        .system_prompt("You are a helpful assistant")
        .model("claude-3-opus-20240229")
        .build();

    let mut client = ClaudeSDKClient::new(options);

    // Connect with initial prompt
    client.connect(Some("Hello!".to_string())).await?;

    // Receive initial response
    let mut messages = client.receive_messages().await;
    while let Some(msg) = messages.next().await {
        match msg? {
            Message::Result { .. } => break,
            msg => println!("{:?}", msg),
        }
    }

    // Send follow-up
    client.send_request("What's 2 + 2?".to_string(), None).await?;

    // Receive response
    let mut messages = client.receive_messages().await;
    while let Some(msg) = messages.next().await {
        println!("{:?}", msg?);
    }

    // Disconnect
    client.disconnect().await?;

    Ok(())
}

Implementations

impl ClaudeSDKClient

pub fn new(options: ClaudeCodeOptions) -> Self

Create a new client with the given options

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

Connect to Claude CLI with an optional initial prompt

pub async fn send_user_message(&mut self, prompt: String) -> Result<()>

Send a user message to Claude

pub async fn send_request( &mut self, prompt: String, _session_id: Option<String>, ) -> Result<()>

Send a request to Claude (alias for send_user_message with optional session_id)

pub async fn receive_messages( &mut self, ) -> impl Stream<Item = Result<Message>> + use<>

Receive messages from Claude

Returns a stream of messages. The stream will end when a Result message is received or the connection is closed.

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

Send an interrupt request

pub async fn is_connected(&self) -> bool

Check if the client is connected

pub async fn get_sessions(&self) -> Vec<String>

Get active session IDs

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

Disconnect from Claude CLI

Trait Implementations

impl Drop for ClaudeSDKClient

fn drop(&mut self)

Executes the destructor for this type.