Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }

Implementations§

Source§

impl Client

Source

pub async fn connect_default() -> Result<Self, ClientError>

Connect using default config (default CLI). Side effects: spawns <cli_bin> app-server. Allocation: runtime buffers + internal channels.

Source

pub async fn connect(config: ClientConfig) -> Result<Self, ClientError>

Connect using explicit client config. Side effects: spawns <cli_bin> app-server and validates initialize compatibility guard. Allocation: runtime buffers + internal channels.

Source

pub async fn run( &self, cwd: impl Into<String>, prompt: impl Into<String>, ) -> Result<PromptRunResult, PromptRunError>

Run one prompt using default policies (approval=never, sandbox=read-only). Side effects: sends thread/turn RPC calls to app-server.

Source

pub async fn run_with( &self, params: PromptRunParams, ) -> Result<PromptRunResult, PromptRunError>

Run one prompt with explicit model/policy/attachment options. Side effects: sends thread/turn RPC calls to app-server.

Source

pub async fn run_with_profile( &self, cwd: impl Into<String>, prompt: impl Into<String>, profile: RunProfile, ) -> Result<PromptRunResult, PromptRunError>

Run one prompt with one reusable profile (model/effort/policy/attachments/timeout). Side effects: sends thread/turn RPC calls to app-server. Allocation: moves profile-owned Strings/vectors + one prompt String. Complexity: O(n), n = attachment count + field sizes.

Source

pub async fn start_session( &self, config: SessionConfig, ) -> Result<Session, PromptRunError>

Start a prepared session and return a reusable handle. Side effects: sends thread/start RPC call to app-server. Allocation: clones model/cwd/sandbox into thread-start payload. Complexity: O(n), n = total field sizes.

Source

pub async fn resume_session( &self, thread_id: &str, config: SessionConfig, ) -> Result<Session, PromptRunError>

Resume an existing session id with prepared defaults. Side effects: sends thread/resume RPC call to app-server. Allocation: clones model/cwd/sandbox into thread-resume payload. Complexity: O(n), n = total field sizes.

Source

pub fn runtime(&self) -> &Runtime

Borrow underlying runtime for full low-level control. Allocation: none. Complexity: O(1).

Source

pub fn config(&self) -> &ClientConfig

Return connect-time client config snapshot. Allocation: none. Complexity: O(1).

Source

pub async fn shutdown(&self) -> Result<(), RuntimeError>

Shutdown child process and background tasks. Side effects: closes channels and terminates child process.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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