Struct Client 

pub struct Client;

The client role - typically an IDE or CLI that controls an agent.

Clients send prompts and receive responses from agents.

Implementations

impl Client

pub fn v1(self) -> Builder<Client>

Create a client builder that uses the ACP protocol v1 API.

Callbacks receive a v1::ConnectionTo and typed handlers receive v1 request handles. With the unstable_protocol_v2 feature, use Client::v2 for a protocol v2 client, or Client::protocol_connector to support both.

pub fn v2(self) -> Builder<Client>

Available on crate feature unstable_protocol_v2 only.

Create a client builder that requires an ACP protocol v2 agent.

Initialize the connection with v2::ConnectionTo::send_initialize. If the agent selects v1, it resolves to InitializeOutcome::LowerVersion rather than an error, and the connection stays uninitialized: fall back to a v1 client implementation if that is acceptable. A plain send_request of a v2 InitializeRequest resolves with an error instead. To let the SDK do the fallback, use Client::protocol_connector.

Requires the unstable_protocol_v2 crate feature.

pub fn protocol_connector(self) -> ClientProtocolConnector

Available on crate feature unstable_protocol_v2 only.

Create a connector that chooses between configured protocol implementations.

Add implementation factories with ClientProtocolConnector::with_v1 and ClientProtocolConnector::with_v2. The resulting connector starts the highest configured protocol implementation. If a v2 implementation successfully negotiates v1 and a v1 implementation is configured, the connector reuses the connection only when the v1 implementation’s complete initialize parameters match what the agent already saw; otherwise it opens a fresh agent connection and restarts with v1.

Requires the unstable_protocol_v2 crate feature while protocol v2 stabilizes.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectTo<Client> for AgentProtocolRouter

Available on crate feature unstable_protocol_v2 only.

async fn connect_to(self, client: impl ConnectTo<Agent>) -> Result<(), Error>

Connect this component to another component.

fn into_channel_and_future(self) -> (Channel, Option<ConnectionDriver>)

where Self: Sized,

Convert this component into a channel endpoint and optional owned driver.

impl Copy for Client

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Client

impl HasPeer<Client> for Client

fn remote_style(&self, _peer: Client) -> RemoteStyle

Returns the remote style for sending to this peer.

impl HasPeer<Client> for Conductor

fn remote_style(&self, _peer: Client) -> RemoteStyle

Returns the remote style for sending to this peer.

impl Hash for Client

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Client

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Client

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Client

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Role for Client

fn default_handle_dispatch_from( &self, message: Dispatch, connection: ConnectionTo<Client>, ) -> impl Future<Output = Result<Handled<Dispatch>, Error>> + Send

Handles the requests and notifications an agent receives from its client that no handler claimed.

A v2 agent (Agent.v2()) answers an unhandled tool_call/cancel or terminal/cancel with -32602: it has no tool call or terminal it can cancel. Every other message is left to the generic -32601 fallback.

type Counterpart = Agent

The role that this endpoint connects to.

fn role_id(&self) -> RoleId

Returns a unique identifier for this role.

fn counterpart(&self) -> Self::Counterpart

Returns the counterpart role.

impl StructuralPartialEq for Client