Skip to main content

Event

Enum Event 

Source
#[non_exhaustive]
pub enum Event { Started { session: String, model: Option<String>, }, Thinking(String), Text(String), ToolCall { id: Option<String>, name: String, input: Value, }, ToolResult { id: Option<String>, ok: Option<bool>, output: String, }, Usage(Usage), ApprovalRequest(Approval), RateLimit(RateLimit), Compaction(Compaction), Commands(Commands), }
Expand description

One normalized thing an agent did, agent-agnostic so a single renderer works across all three.

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

Started

The session is live. Emitted once, as early as the agent reveals it.

Fields

§session: String

The native session id.

§model: Option<String>

The model actually selected, when named.

§

Thinking(String)

Reasoning text, where the agent exposes it.

§

Text(String)

Assistant text as it arrives.

§

ToolCall

The agent invoked a tool.

Fields

§id: Option<String>

Correlates with the matching Event::ToolResult, when the agent provides an id.

§name: String

The tool’s name.

§input: Value

Its arguments, in the agent’s own shape.

§

ToolResult

A tool returned.

Fields

§id: Option<String>

Correlates with the originating Event::ToolCall.

§ok: Option<bool>

Whether the tool reported success. None when the agent does not say.

§output: String

The observation the model saw.

§

Usage(Usage)

Token usage so far, reported while the turn is still running.

For a live counter in a UI. Emitted once per model call, so a host can fold each into a running total with crate::Usage::accumulate, whose per-field rules were written for exactly this.

output_tokens is deliberately absent here. Mid-turn the agent reports the count as it stood when the message began, which understates the finished figure badly: a run whose per-call reports summed to 9 had generated 497 by the end. The context figures are exact, so a counter built on crate::Usage::context_tokens is honest and one built on output would not be. The true output count arrives with the crate::Outcome.

Claude reports this throughout a turn. Copilot reports once, near the end. Codex reports nothing until the turn completes, so it never emits this.

§

ApprovalRequest(Approval)

The agent is waiting for permission to make a tool call.

Only emitted when the request asked for it via crate::Request::approvals. The run is blocked until crate::Run::respond answers it, so a consumer that ignores this stalls until the run’s timeout.

§

RateLimit(RateLimit)

A quota signal. Reported, never acted on.

§

Compaction(Compaction)

A /compact started or settled.

Only on a run carrying crate::Command::Compact. A refusal arrives here as crate::Compaction::Finished with a reason rather than as an error, because the command ran and answered. Claude only.

§

Commands(Commands)

What the agent reports it can do, emitted once as the run starts.

The catalogue is the agent’s own, not this crate’s: skills, plugins and user commands differ per install. Claude only; nothing else publishes one.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

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 Event

Source§

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

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

impl<'de> Deserialize<'de> for Event

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Event

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Event

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.