Skip to main content

ControlDispatchHandle

Struct ControlDispatchHandle 

Source
pub(crate) struct ControlDispatchHandle {
    writer: Arc<SharedWriter>,
    can_use_tool: Option<Arc<dyn CanUseToolCallback>>,
    auto_approve_tool: Option<Arc<dyn Fn(&str) -> bool + Send + Sync>>,
    mcp_hosts: McpHosts,
    hook_callbacks: HashMap<String, Arc<dyn ErasedHookCallback>>,
    session_id: Arc<RwLock<String>>,
}
Expand description

Clonable bundle of state + writer that dispatches a single control_request. Internal - built once during Client::spawn and cloned by the reader task per inbound request.

Each field is Arc-backed (or Clone); cloning the handle is cheap. Designed to be moved into a tokio::spawn’d task per inbound control_request.

Fields§

§writer: Arc<SharedWriter>§can_use_tool: Option<Arc<dyn CanUseToolCallback>>§auto_approve_tool: Option<Arc<dyn Fn(&str) -> bool + Send + Sync>>§mcp_hosts: McpHosts§hook_callbacks: HashMap<String, Arc<dyn ErasedHookCallback>>§session_id: Arc<RwLock<String>>

Implementations§

Source§

impl ControlDispatchHandle

Source

pub(crate) fn new( writer: Arc<SharedWriter>, can_use_tool: Option<Arc<dyn CanUseToolCallback>>, auto_approve_tool: Option<Arc<dyn Fn(&str) -> bool + Send + Sync>>, mcp_hosts: McpHosts, hook_callbacks: HashMap<String, Arc<dyn ErasedHookCallback>>, session_id: Arc<RwLock<String>>, ) -> Self

Source

pub(crate) fn capture_session_id_from(&self, msg: &Message)

Capture a session id from an incoming Message. No-op once a non-empty id has been bound. Called by the reader task on every message.

Source

pub(crate) async fn dispatch(&self, req: ControlRequest) -> Result<(), Error>

Dispatch one inbound control_request. Routes the request to the right handler (MCP, hook callback, can_use_tool) and writes the matching control_response via the cloned SharedWriter. Safe to call from a tokio::spawn’d task - runs to completion regardless of caller cancellation.

On handler failure the CLI is best-effort answered with an error control_response before the error surfaces - an unanswered request hangs the subprocess’s in-flight tool call.

§Errors

Same shape as Client::handle_control: encode/serialise failures from Error::message_parse / Error::encode, and write failures from the underlying writer.

Source

pub(crate) async fn write_error_response(&self, request_id: &str, error: &str)

Best-effort error control_response for a request we could not handle. The CLI blocks on an unanswered request, so any frame carrying a request_id must be answered even on failure.

Source

async fn dispatch_inner(&self, req: ControlRequest) -> Result<(), Error>

Source

async fn write_unsupported(&self, req: &ControlRequest) -> Result<(), Error>

Source

async fn handle_mcp( &self, req: &ControlRequest, server_name: &str, message: &Value, ) -> Result<(), Error>

Source

async fn handle_hook( &self, req: &ControlRequest, callback_id: &str, input: &Value, tool_use_id: Option<&str>, ) -> Result<(), Error>

Trait Implementations§

Source§

impl Clone for ControlDispatchHandle

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 Debug for ControlDispatchHandle

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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 = !

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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