Enum EventMsg 

pub enum EventMsg {
    Error(ErrorEvent),
    Warning(WarningEvent),
    TaskStarted(TaskStartedEvent),
    TaskComplete(TaskCompleteEvent),
    TokenCount(TokenCountEvent),
    AgentMessage(AgentMessageEvent),
    UserMessage(UserMessageEvent),
    AgentMessageDelta(AgentMessageDeltaEvent),
    AgentReasoning(AgentReasoningEvent),
    AgentReasoningDelta(AgentReasoningDeltaEvent),
    AgentReasoningRawContent(AgentReasoningRawContentEvent),
    AgentReasoningRawContentDelta(AgentReasoningRawContentDeltaEvent),
    AgentReasoningSectionBreak(AgentReasoningSectionBreakEvent),
    SessionConfigured(SessionConfiguredEvent),
    McpStartupUpdate(McpStartupUpdateEvent),
    McpStartupComplete(McpStartupCompleteEvent),
    McpToolCallBegin(McpToolCallBeginEvent),
    McpToolCallEnd(McpToolCallEndEvent),
    WebSearchBegin(WebSearchBeginEvent),
    WebSearchEnd(WebSearchEndEvent),
    ExecCommandBegin(ExecCommandBeginEvent),
    ExecCommandOutputDelta(ExecCommandOutputDeltaEvent),
    ExecCommandEnd(ExecCommandEndEvent),
    ViewImageToolCall(ViewImageToolCallEvent),
    ExecApprovalRequest(ExecApprovalRequestEvent),
    ApplyPatchApprovalRequest(ApplyPatchApprovalRequestEvent),
    DeprecationNotice(DeprecationNoticeEvent),
    BackgroundEvent(BackgroundEventEvent),
    UndoStarted(UndoStartedEvent),
    UndoCompleted(UndoCompletedEvent),
    StreamError(StreamErrorEvent),
    PatchApplyBegin(PatchApplyBeginEvent),
    PatchApplyEnd(PatchApplyEndEvent),
    TurnDiff(TurnDiffEvent),
    GetHistoryEntryResponse(GetHistoryEntryResponseEvent),
    McpListToolsResponse(McpListToolsResponseEvent),
    ListCustomPromptsResponse(ListCustomPromptsResponseEvent),
    PlanUpdate(UpdatePlanArgs),
    TurnAborted(TurnAbortedEvent),
    ShutdownComplete,
    EnteredReviewMode(ReviewRequest),
    ExitedReviewMode(ExitedReviewModeEvent),
    RawResponseItem(RawResponseItemEvent),
    ItemStarted(ItemStartedEvent),
    ItemCompleted(ItemCompletedEvent),
    AgentMessageContentDelta(AgentMessageContentDeltaEvent),
    ReasoningContentDelta(ReasoningContentDeltaEvent),
    ReasoningRawContentDelta(ReasoningRawContentDeltaEvent),
}

Response event from the agent NOTE: Make sure none of these values have optional types, as it will mess up the extension code-gen.

Variants

Error(ErrorEvent)

Error while executing a submission

Warning(WarningEvent)

Warning issued while processing a submission. Unlike Error, this indicates the task continued but the user should still be notified.

TaskStarted(TaskStartedEvent)

Agent has started a task

TaskComplete(TaskCompleteEvent)

Agent has completed all actions

TokenCount(TokenCountEvent)

Usage update for the current session, including totals and last turn. Optional means unknown — UIs should not display when None.

AgentMessage(AgentMessageEvent)

Agent text output message

UserMessage(UserMessageEvent)

User/system input message (what was sent to the model)

AgentMessageDelta(AgentMessageDeltaEvent)

Agent text output delta message

AgentReasoning(AgentReasoningEvent)

Reasoning event from agent.

AgentReasoningDelta(AgentReasoningDeltaEvent)

Agent reasoning delta event from agent.

AgentReasoningRawContent(AgentReasoningRawContentEvent)

Raw chain-of-thought from agent.

AgentReasoningRawContentDelta(AgentReasoningRawContentDeltaEvent)

Agent reasoning content delta event from agent.

AgentReasoningSectionBreak(AgentReasoningSectionBreakEvent)

Signaled when the model begins a new reasoning summary section (e.g., a new titled block).

SessionConfigured(SessionConfiguredEvent)

Ack the client’s configure message.

McpStartupUpdate(McpStartupUpdateEvent)

Incremental MCP startup progress updates.

McpStartupComplete(McpStartupCompleteEvent)

Aggregate MCP startup completion summary.

McpToolCallBegin(McpToolCallBeginEvent)

McpToolCallEnd(McpToolCallEndEvent)

WebSearchBegin(WebSearchBeginEvent)

WebSearchEnd(WebSearchEndEvent)

ExecCommandBegin(ExecCommandBeginEvent)

Notification that the server is about to execute a command.

ExecCommandOutputDelta(ExecCommandOutputDeltaEvent)

Incremental chunk of output from a running command.

ExecCommandEnd(ExecCommandEndEvent)

ViewImageToolCall(ViewImageToolCallEvent)

Notification that the agent attached a local image via the view_image tool.

ExecApprovalRequest(ExecApprovalRequestEvent)

ApplyPatchApprovalRequest(ApplyPatchApprovalRequestEvent)

DeprecationNotice(DeprecationNoticeEvent)

Notification advising the user that something they are using has been deprecated and should be phased out.

BackgroundEvent(BackgroundEventEvent)

UndoStarted(UndoStartedEvent)

UndoCompleted(UndoCompletedEvent)

StreamError(StreamErrorEvent)

Notification that a model stream experienced an error or disconnect and the system is handling it (e.g., retrying with backoff).

PatchApplyBegin(PatchApplyBeginEvent)

Notification that the agent is about to apply a code patch. Mirrors ExecCommandBegin so front‑ends can show progress indicators.

PatchApplyEnd(PatchApplyEndEvent)

Notification that a patch application has finished.

TurnDiff(TurnDiffEvent)

GetHistoryEntryResponse(GetHistoryEntryResponseEvent)

Response to GetHistoryEntryRequest.

McpListToolsResponse(McpListToolsResponseEvent)

List of MCP tools available to the agent.

ListCustomPromptsResponse(ListCustomPromptsResponseEvent)

List of custom prompts available to the agent.

PlanUpdate(UpdatePlanArgs)

TurnAborted(TurnAbortedEvent)

ShutdownComplete

Notification that the agent is shutting down.

EnteredReviewMode(ReviewRequest)

Entered review mode.

ExitedReviewMode(ExitedReviewModeEvent)

Exited review mode with an optional final result to apply.

RawResponseItem(RawResponseItemEvent)

ItemStarted(ItemStartedEvent)

ItemCompleted(ItemCompletedEvent)

AgentMessageContentDelta(AgentMessageContentDeltaEvent)

ReasoningContentDelta(ReasoningContentDeltaEvent)

ReasoningRawContentDelta(ReasoningRawContentDeltaEvent)

Trait Implementations

impl Clone for EventMsg

fn clone(&self) -> EventMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventMsg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EventMsg

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

Formats the value using the given formatter.

impl HasLegacyEvent for EventMsg

fn as_legacy_events(&self, show_raw_agent_reasoning: bool) -> Vec<EventMsg>

impl JsonSchema for EventMsg

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for EventMsg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for EventMsg

type WithoutGenerics = EventMsg

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = EventMsg

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.