Skip to main content

Proxy

Struct Proxy 

Source
pub struct Proxy;
Expand description

The proxy role - an intermediary that can intercept and modify messages.

Proxies sit between a client and an agent (or another proxy), and can:

  • Add tools via MCP servers
  • Filter or transform messages
  • Inject additional context

Proxies connect to a Conductor which orchestrates the proxy chain.

Implementations§

Source§

impl Proxy

Source

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

Create a stable protocol v1 connection builder for a proxy.

The proxy negotiates proxy/initialize the way a v1 agent negotiates initialize: it selects v1 for every requested version. A request for a newer version keeps what parses under v1, and one below v1 keeps v1’s fallback-to-latest rule.

Use Proxy::v2 for a protocol-v2-only proxy with typed callbacks and wire validation. Protocol-routing infrastructure that deliberately selects a version itself can use the unguarded Builder::new(Proxy).

Typed handlers on this builder receive V1 request handles.

Source

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

Available on crate feature unstable_protocol_v2 only.

Create a proxy builder that uses the ACP protocol v2 API.

The proxy negotiates proxy/initialize the way a v2 agent negotiates initialize: it selects v2 for a request for v2 or newer, keeping what parses under v2 for a newer request, and rejects a request below v2 with -32022. Fluent callbacks receive v2::ConnectionTo<Conductor>, while low-level custom handlers and runners retain the protocol-neutral ConnectionTo interface.

Requires the unstable_protocol_v2 crate feature.

Source

pub fn protocol_router(self) -> ProxyProtocolRouter

Available on crate feature unstable_protocol_v2 only.

Create a router that chooses between configured proxy implementations.

Add implementations with ProxyProtocolRouter::with_v1 and ProxyProtocolRouter::with_v2. The router reads the initial proxy/initialize request and selects an implementation exactly as Agent::protocol_router does for initialize: a request for v2 or newer selects the v2 implementation, keeping what parses under v2 for a newer request. With a v1 implementation configured, everything else is handed to the v1 implementation, which negotiates it as it would without the router. A v2-only router rejects a request below v2 with -32022. Like the agent router, it answers each rejected request or malformed frame with an error and keeps reading, so the conductor can send proxy/initialize again. A request for exactly the selected version is handed over in the complete, unchanged initial transport frame. The router does not convert later messages.

Requires the unstable_protocol_v2 crate feature while protocol v2 stabilizes.

Trait Implementations§

Source§

impl Clone for Proxy

Source§

fn clone(&self) -> Self

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 Copy for Proxy

Source§

impl Debug for Proxy

Source§

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

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

impl Default for Proxy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Proxy

Source§

impl HasPeer<Proxy> for Proxy

Source§

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

Returns the remote style for sending to this peer.
Source§

impl Hash for Proxy

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Proxy

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for Proxy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Proxy

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Role for Proxy

Source§

type Counterpart = Conductor

The role that this endpoint connects to. Read more
Source§

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

Method invoked when there is no defined message handler.
Source§

fn role_id(&self) -> RoleId

Returns a unique identifier for this role.
Source§

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

Returns the counterpart role.
Source§

impl StructuralPartialEq for Proxy

Auto Trait Implementations§

§

impl Freeze for Proxy

§

impl RefUnwindSafe for Proxy

§

impl Send for Proxy

§

impl Sync for Proxy

§

impl Unpin for Proxy

§

impl UnsafeUnpin for Proxy

§

impl UnwindSafe for Proxy

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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