Struct Client

pub struct Client { /* private fields */ }

High-level client for interacting with Claude Code CLI

The Client provides a type-safe, async interface to Claude Code with support for different output formats, configuration options, and both simple and advanced response handling.

Examples

Basic usage:

let client = Client::new(Config::default());
let response = client.query("Hello").send().await?;
println!("{}", response);

With configuration:

let client = Client::builder()
    .model("claude-3-opus-20240229")
    .stream_format(StreamFormat::Json)
    .timeout_secs(60)
    .build();

Implementations

impl Client

pub fn new(config: Config) -> Self

Create a new client with the given configuration

pub fn builder() -> ClientBuilder

Create a new client builder for fluent configuration

pub fn query(&self, query: impl Into<String>) -> QueryBuilder

Create a query builder for the given query string

Examples

let client = Client::new(Config::default());
let response = client
    .query("Explain Rust ownership")
    .send()
    .await?;

pub async fn send(&self, query: &str) -> Result<String>

Send a query and return just the text content (backwards compatible)

This is the simplest way to get a response from Claude. For access to metadata, costs, and raw JSON, use send_full.

Examples

let client = Client::new(Config::default());
let answer = client.send("What is 2 + 2?").await?;
assert_eq!(answer.trim(), "4");

pub async fn send_full(&self, query: &str) -> Result<ClaudeResponse>

Send a query and return the full response with metadata and raw JSON

This method provides access to the complete response from Claude Code, including metadata like costs, session IDs, and the raw JSON for advanced parsing or storage.

Examples

let client = Client::builder()
    .stream_format(StreamFormat::Json)
    .build();

let response = client.send_full("Hello").await?;
println!("Content: {}", response.content);

if let Some(metadata) = &response.metadata {
    println!("Cost: ${:.6}", metadata.cost_usd.unwrap_or(0.0));
    println!("Session: {}", metadata.session_id);
}

// Access raw JSON for custom parsing
if let Some(raw) = &response.raw_json {
    // Custom field extraction
    let custom_field = raw.get("custom_field");
}

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.