Struct ClaudeClient 

pub struct ClaudeClient<R: CommandRunner = DefaultRunner> { /* private fields */ }

Claude Code CLI client.

Implementations

impl ClaudeClient

pub fn new(config: ClaudeConfig) -> Self

Creates a new client with the default DefaultRunner.

impl ClaudeClient

pub async fn ask_stream( &self, prompt: &str, ) -> Result<Pin<Box<dyn Stream<Item = Result<StreamEvent, ClaudeError>> + Send>>, ClaudeError>

Available on crate feature stream only.

Sends a prompt and returns a stream of events.

Spawns the CLI with --output-format stream-json and streams events in real-time. The stream ends with a StreamEvent::Result on success.

For real-time token-level streaming, enable crate::ClaudeConfigBuilder::include_partial_messages. This produces StreamEvent::Text / StreamEvent::Thinking delta chunks. Without it, only complete StreamEvent::AssistantText / StreamEvent::AssistantThinking messages are emitted.

Use crate::ClaudeConfigBuilder::stream_idle_timeout to set an idle timeout. If no event arrives within the specified duration, the stream yields ClaudeError::Timeout and terminates.

impl<R: CommandRunner> ClaudeClient<R>

pub fn with_runner(config: ClaudeConfig, runner: R) -> Self

Creates a new client with a custom CommandRunner for testing.

pub async fn ask_structured<T: DeserializeOwned>( &self, prompt: &str, ) -> Result<T, ClaudeError>

Sends a prompt and deserializes the result into T.

Requires json_schema to be set on the config beforehand. Use generate_schema to auto-generate it (requires the structured feature).

pub async fn ask(&self, prompt: &str) -> Result<ClaudeResponse, ClaudeError>

Sends a prompt and returns the response.

impl<R: CommandRunner + Clone> ClaudeClient<R>

pub fn conversation(&self) -> Conversation<R>

Creates a new Conversation for multi-turn interaction.

The conversation manages session_id automatically, injecting --resume from the second turn onwards.

Callers must set crate::ClaudeConfigBuilder::no_session_persistence(false) for multi-turn to work.

pub fn conversation_resume( &self, session_id: impl Into<String>, ) -> Conversation<R>

Creates a Conversation that resumes an existing session.

The first ask() / ask_stream() call will include --resume with the given session ID.

Trait Implementations

impl<R: Clone + CommandRunner> Clone for ClaudeClient<R>

fn clone(&self) -> ClaudeClient<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug + CommandRunner> Debug for ClaudeClient<R>

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

Formats the value using the given formatter.