Skip to main content

ClaudeCodeDriver

Struct ClaudeCodeDriver 

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

Driver that talks to the Claude Code CLI (or any stream-json compatible agent) via the SDK’s --input-format=stream-json --output-format=stream-json protocol.

Implementations§

Source§

impl ClaudeCodeDriver

Source

pub fn finish_input(&mut self)

Signal that no more user input will be sent in this session. This closes claude’s stdin, after which claude will process any pending frames, emit its final result frame, and exit.

For one-shot interactions this should be called immediately after the final Driver::send. For long-running sessions (multi-turn interactive use) leave stdin open and rely on Driver::shutdown to terminate.

Source§

impl ClaudeCodeDriver

Source

pub async fn spawn(cwd: impl AsRef<Path>) -> Result<Self, DriverError>

Spawn a fresh Claude Code session in the given working directory, using the binary on PATH (or $CLAUDE_BIN env override).

Defaults to persistent session mode via --replay-user-messages — one claude process serves an unbounded number of turns. Call Self::finish_input when you’re done so claude can exit gracefully. For multi-turn use, just keep calling Driver::send.

Source

pub fn builder(cwd: impl AsRef<Path>) -> ClaudeCodeDriverBuilder

Begin building a Claude Code session with custom options.

Trait Implementations§

Source§

impl Debug for ClaudeCodeDriver

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Driver for ClaudeCodeDriver

Source§

fn send<'life0, 'async_trait>( &'life0 mut self, frame: ClientFrame, ) -> Pin<Box<dyn Future<Output = Result<(), DriverError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Send a frame to the agent. The frame is processed asynchronously; resulting events arrive via Driver::next_event.
Source§

fn next_event<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<AgentEvent>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Await the next event from the agent. Returns None when the agent has exited cleanly.
Source§

fn shutdown<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), DriverError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Shut down the agent process and release resources.

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> 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, 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