Skip to main content

UserEvent

Enum UserEvent 

Source
#[non_exhaustive]
pub enum UserEvent { Message { content: Vec<ContentBlock>, }, Interrupt {}, ToolConfirmation { tool_use_id: String, result: ConfirmationResult, deny_message: Option<String>, }, CustomToolResult { custom_tool_use_id: String, content: Vec<ContentBlock>, }, ToolResult { tool_use_id: String, content: Vec<ContentBlock>, }, DefineOutcome { criteria: String, }, }
Expand description

Client-to-agent event. Discriminated by type field for wire serialization.

§Wire Shapes (CANON §3.4)

{"type": "user.message", "content": [{"type": "text", "text": "Hello"}]}
{"type": "user.interrupt"}

§Example

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

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

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

Send a message turn.

Fields

§content: Vec<ContentBlock>

The message content blocks.

§

Interrupt

Interrupt the current turn.

§

ToolConfirmation

Approve or deny a tool confirmation request.

Fields

§tool_use_id: String

The tool use ID being confirmed.

§result: ConfirmationResult

Whether to allow or deny.

§deny_message: Option<String>

Optional message explaining why the tool was denied.

§

CustomToolResult

Return results for a client-executed custom tool.

Fields

§custom_tool_use_id: String

The custom tool use ID this result corresponds to.

§content: Vec<ContentBlock>

The result content blocks.

§

ToolResult

Return results for a built-in tool (self-hosted only). In hosted topology, built-in tools execute server-side in the sandbox.

Fields

§tool_use_id: String

The tool use ID this result corresponds to.

§content: Vec<ContentBlock>

The result content blocks.

§

DefineOutcome

Define success criteria for the session.

Fields

§criteria: String

The success criteria description.

Trait Implementations§

Source§

impl Clone for UserEvent

Source§

fn clone(&self) -> UserEvent

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 UserEvent

Source§

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

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

impl<'de> Deserialize<'de> for UserEvent

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 UserEvent

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