Enum OutgoingUserEvent 

#[non_exhaustive]
pub enum OutgoingUserEvent {
    Message {
        content: Vec<UserContentBlock>,
    },
    Interrupt {},
    CustomToolResult {
        custom_tool_use_id: String,
        content: Vec<UserContentBlock>,
        is_error: Option<bool>,
        session_thread_id: Option<String>,
    },
    ToolConfirmation {
        tool_use_id: String,
        result: ConfirmationResult,
        deny_message: Option<String>,
        session_thread_id: Option<String>,
    },
    DefineOutcome(UserDefineOutcomeEvent),
}

Available on crate feature managed-agents-preview only.

One event included in a Events::send call.

This is the outgoing form – the user-event variants only. For the echoed / received form (which can also carry agent / session / span events) use SessionEvent.

Variants (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 user message.

Fields

content: Vec<UserContentBlock>

Content blocks.

Interrupt

Interrupt the agent mid-execution.

CustomToolResult

Respond to an agent.custom_tool_use.

Fields

custom_tool_use_id: String

ID of the matching agent.custom_tool_use event.

content: Vec<UserContentBlock>

Result content.

is_error: Option<bool>

Optional error flag.

session_thread_id: Option<String>

Multi-agent routing: set to the value from the originating agent.custom_tool_use event’s session_thread_id field when responding to a sub-agent thread. Leave None for primary-thread events.

ToolConfirmation

Allow or deny a pending tool call.

Fields

tool_use_id: String

ID of the matching agent.tool_use event.

result: ConfirmationResult

Allow or deny.

deny_message: Option<String>

Optional explanation for a deny.

session_thread_id: Option<String>

Multi-agent routing: set to the originating event’s session_thread_id. Leave None for primary-thread events.

DefineOutcome(UserDefineOutcomeEvent)

Define an outcome.

Implementations

impl OutgoingUserEvent

pub fn message(text: impl Into<String>) -> Self

Build a simple user.message from a single text string.

pub fn interrupt() -> Self

Build a user.interrupt.

pub fn allow_tool(tool_use_id: impl Into<String>) -> Self

Build a user.tool_confirmation (allow).

pub fn deny_tool( tool_use_id: impl Into<String>, deny_message: impl Into<String>, ) -> Self

Build a user.tool_confirmation (deny with message).

pub fn custom_tool_result_text( custom_tool_use_id: impl Into<String>, text: impl Into<String>, ) -> Self

Build a user.custom_tool_result with a single text block.

pub fn with_session_thread_id(self, thread_id: impl Into<String>) -> Self

Attach a session_thread_id to a ToolConfirmation or CustomToolResult event for multi-agent thread routing. No-op on other variants.

Trait Implementations

impl Clone for OutgoingUserEvent

fn clone(&self) -> OutgoingUserEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutgoingUserEvent

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

Formats the value using the given formatter.

impl PartialEq for OutgoingUserEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OutgoingUserEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OutgoingUserEvent