Skip to main content

SessionEvent

Enum SessionEvent 

Source
#[non_exhaustive]
pub enum SessionEvent { Message { content: Vec<ContentBlock>, seq: u64, }, ToolUse { tool_use_id: String, name: String, input: Value, seq: u64, }, CustomToolUse { custom_tool_use_id: String, name: String, input: Value, seq: u64, }, McpToolUse { tool_use_id: String, name: String, input: Value, seq: u64, }, StatusRunning { seq: u64, }, StatusIdle { seq: u64, stop_reason: Option<StopReason>, usage: Option<UsageReport>, }, Error { code: String, message: String, seq: u64, }, }
Expand description

Agent-to-client event. Each carries a monotonic seq per session.

§Wire Shapes (CANON §3.4)

{"type": "agent.message", "content": [{"type": "text", "text": "Hi"}], "seq": 1}
{"type": "status.running", "seq": 2}
{"type": "status.idle", "seq": 3, "stop_reason": {"reason": "end_turn"}}

§Example

use adk_managed::types::{SessionEvent, ContentBlock};

let event = SessionEvent::Message {
    content: vec![ContentBlock::Text { text: "Hello".to_string() }],
    seq: 1,
};
let json = serde_json::to_string(&event).unwrap();
assert!(json.contains(r#""type":"agent.message""#));
assert!(json.contains(r#""seq":1"#));

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

Message

Assistant message content.

Fields

§content: Vec<ContentBlock>

The message content blocks.

§seq: u64

Monotonically increasing sequence number.

§

ToolUse

Built-in tool invocation (executes server-side in sandbox).

Fields

§tool_use_id: String

Unique identifier for this tool use.

§name: String

Tool name.

§input: Value

Tool input parameters.

§seq: u64

Monotonically increasing sequence number.

§

CustomToolUse

Custom tool invocation (client must execute and return result). The loop PARKS until user.custom_tool_result with matching ID arrives.

Fields

§custom_tool_use_id: String

Unique identifier for this custom tool use.

§name: String

Tool name.

§input: Value

Tool input parameters.

§seq: u64

Monotonically increasing sequence number.

§

McpToolUse

MCP tool invocation.

Fields

§tool_use_id: String

Unique identifier for this MCP tool use.

§name: String

Tool name.

§input: Value

Tool input parameters.

§seq: u64

Monotonically increasing sequence number.

§

StatusRunning

Session became active (processing a turn).

Fields

§seq: u64

Monotonically increasing sequence number.

§

StatusIdle

Turn complete; awaiting next event. Includes stop_reason to tell the caller WHY the turn ended, and usage reporting token consumption for billing/metering.

Fields

§seq: u64

Monotonically increasing sequence number.

§stop_reason: Option<StopReason>

Why the turn ended. Enables the client to decide what to do next.

§usage: Option<UsageReport>

Token usage for this turn (input/output/total). Present when the LLM reports usage metadata; None on error turns.

§

Error

Error during execution.

Fields

§code: String

Error code identifier.

§message: String

Human-readable error message.

§seq: u64

Monotonically increasing sequence number.

Trait Implementations§

Source§

impl Clone for SessionEvent

Source§

fn clone(&self) -> SessionEvent

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 SessionEvent

Source§

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

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

impl<'de> Deserialize<'de> for SessionEvent

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 Serialize for SessionEvent

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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