Skip to main content

AgentEvent

Enum AgentEvent 

Source
pub enum AgentEvent {
    SessionInit {
        session_id: String,
        model: String,
    },
    Text(String),
    ToolUse {
        name: String,
        input: Value,
    },
    QuestionPending {
        request_id: String,
        questions: Value,
    },
    TurnComplete {
        result: Option<String>,
        subtype: String,
        num_turns: u32,
        duration_ms: u64,
        is_error: bool,
        session_id: String,
    },
    ToolApprovalPending {
        request_id: String,
        tool_name: String,
        tool_input: Value,
    },
    ToolProgress {
        tool_name: String,
    },
    ProcessExited {
        code: Option<i32>,
    },
}
Expand description

Events emitted by an agent during a session.

Agents communicate asynchronously via events. Handlers receive these events through the AgentHandle.receiver channel and respond by:

  • Displaying text to the user
  • Posting tool activity notifications
  • Waiting for user input (questions)
  • Finalizing the turn when complete

§Event Flow

  1. SessionInit - Session starts (provides session_id)
  2. Text, ToolUse, ToolProgress - Activity during the turn (may repeat)
  3. QuestionPending - If Claude asks a question (blocks until answered)
  4. TurnComplete - Turn finishes successfully

Alternatively, ProcessExited can occur at any time if the agent crashes.

Variants§

§

SessionInit

Session initialized (carries session_id, model).

Fields

§session_id: String
§model: String
§

Text(String)

Text content from Claude.

§

ToolUse

Claude is using a tool.

Fields

§name: String
§input: Value
§

QuestionPending

Claude is asking the user a question via control_request (AskUserQuestion tool).

Fields

§request_id: String
§questions: Value
§

TurnComplete

A turn completed.

Fields

§result: Option<String>
§subtype: String
§num_turns: u32
§duration_ms: u64
§is_error: bool
§session_id: String
§

ToolApprovalPending

Claude wants to use a tool that requires user approval.

Fields

§request_id: String
§tool_name: String
§tool_input: Value
§

ToolProgress

Tool progress heartbeat.

Fields

§tool_name: String
§

ProcessExited

Agent process exited unexpectedly.

Fields

§code: Option<i32>

Trait Implementations§

Source§

impl Debug for AgentEvent

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

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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