Skip to main content

InboundMessage

Enum InboundMessage 

Source
#[non_exhaustive]
pub enum InboundMessage { System(SystemMessage), User(InboundUserMessage), Assistant(AssistantMessage), StreamEvent(StreamEventMessage), Result(ResultMessage), ControlRequest(ControlRequest), ControlResponse(InboundControlResponse), KeepAlive(KeepAliveMessage), ControlCancelRequest(ControlCancelRequest), Other(Value), }
Expand description

Every stdout line deserializes to this. Source: chunk-20bv8pca.js (various schema locations)

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

System(SystemMessage)

Per-turn metadata. First frame before each turn.

§

User(InboundUserMessage)

A user message: the echo of a host prompt (is_replay) or a tool result.

§

Assistant(AssistantMessage)

Complete assistant message block.

§

StreamEvent(StreamEventMessage)

Partial streaming chunk (requires –include-partial-messages).

§

Result(ResultMessage)

Turn complete signal.

§

ControlRequest(ControlRequest)

CLI asking the host to answer: a hook callback, a tool permission (can_use_tool) or an SDK MCP message. Source: chunk-20bv8pca.js:18214

§

ControlResponse(InboundControlResponse)

CLI answering a host-initiated control request (initialize, interrupt, …). Source: query.py:180–192

§

KeepAlive(KeepAliveMessage)

Process keepalive with startup marker. Source: chunk-f89nsf5q.query.js:1403–1410

§

ControlCancelRequest(ControlCancelRequest)

The CLI withdrew a control request it sent (e.g. a can_use_tool whose turn was interrupted); its answer is no longer wanted.

§

Other(Value)

Any other frame type (rate_limit_event, tool_progress, prompt_suggestion, command_lifecycle, …), kept verbatim.

Trait Implementations§

Source§

impl Clone for InboundMessage

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 InboundMessage

Source§

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

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

impl<'de> Deserialize<'de> for InboundMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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