Skip to main content

ClaudeCodeDriverBuilder

Struct ClaudeCodeDriverBuilder 

Source
pub struct ClaudeCodeDriverBuilder { /* private fields */ }
Expand description

Fluent configuration for ClaudeCodeDriver.

use cap_rs::driver::stream_json::ClaudeCodeDriver;

// Persistent multi-turn session (default).
let chat = ClaudeCodeDriver::builder("/path/to/workspace").spawn().await?;

// One-shot, with a specific model.
let oneshot = ClaudeCodeDriver::builder(".")
    .model("claude-opus-4-7")
    .replay_user_messages(false)
    .spawn()
    .await?;

// Resume an earlier session.
let resumed = ClaudeCodeDriver::builder(".")
    .resume("00000000-0000-0000-0000-deadbeefcafe")
    .spawn()
    .await?;

Implementations§

Source§

impl ClaudeCodeDriverBuilder

Source

pub fn bin(self, bin: impl Into<String>) -> Self

Override the binary used (default: claude on PATH, or $CLAUDE_BIN).

Source

pub fn model(self, model: impl Into<String>) -> Self

Override the model (default: claude’s own default).

Source

pub fn session_id(self, uuid: impl Into<String>) -> Self

Use a specific session UUID for this session (must be a valid UUID per claude’s --session-id requirements). If unset, claude generates one and reports it in the Ready event.

Source

pub fn resume(self, uuid: impl Into<String>) -> Self

Resume a previously persisted conversation by session UUID. Pass the session_id you got from a prior session’s Ready event.

Source

pub fn replay_user_messages(self, on: bool) -> Self

Whether to start in persistent session mode (default: true).

When true, claude stays alive after each turn waiting for more user messages — this is what enables real-time multi-turn conversation in a single process. When false, claude reads one prompt, responds, and exits (one-shot, lower latency to first answer but no follow-ups in the same process).

Implementation note: this maps directly to claude’s --replay-user-messages flag.

Source

pub fn dangerously_skip_permissions(self, on: bool) -> Self

Whether to pass --dangerously-skip-permissions (default: true). When false, claude will prompt for permission on tool calls; the driver currently has no way to route those prompts back through CAP — set this to false only if you don’t care about auto-approving (or you trust the agent to deny dangerous ops).

Source

pub async fn spawn(self) -> Result<ClaudeCodeDriver, DriverError>

Spawn the configured Claude Code session.

Trait Implementations§

Source§

impl Clone for ClaudeCodeDriverBuilder

Source§

fn clone(&self) -> ClaudeCodeDriverBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClaudeCodeDriverBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more