Struct SubagentStartedEvent 

pub struct SubagentStartedEvent {
    pub base: BaseEvent,
    pub subagent_run_id: SubagentRunId,
    pub name: String,
    pub description: Option<String>,
    pub parent_subagent_run_id: Option<SubagentRunId>,
    pub parent_tool_call_id: Option<ToolCallId>,
    pub parent_message_id: Option<MessageId>,
}

Announces a subagent invocation and gives it a name a UI can display.

On this event, unlike the attributable ones, subagent_run_id is required: it is the subject, not a tag.

Fields

base: BaseEvent

Timestamp, raw provider event and metadata.

subagent_run_id: SubagentRunId

Opaque id for this invocation. See the module docs for what it is not.

name: String

The subagent’s declared type or name, for display — the reusable half.

description: Option<String>

Human-readable description.

parent_subagent_run_id: Option<SubagentRunId>

The enclosing subagent, when subagents nest. May name one that has already finished — a parent legitimately finishes before its child.

parent_tool_call_id: Option<ToolCallId>

The tool call that spawned this subagent, for the agents-as-tools pattern: lets a consumer render the subagent inside the tool-call card without inspecting rawEvent.

parent_message_id: Option<MessageId>

The message that held that tool call.

Implementations

impl SubagentStartedEvent

pub fn new( subagent_run_id: impl Into<SubagentRunId>, name: impl Into<String>, ) -> Self

Announces a subagent invocation.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_parent_subagent(self, parent: impl Into<SubagentRunId>) -> Self

Names the enclosing subagent.

pub fn with_parent_tool_call(self, tool_call_id: impl Into<ToolCallId>) -> Self

Links the subagent to the tool call that spawned it — the agents-as-tools pattern, where a UI draws the subagent inside the call’s card.

pub fn with_parent_message(self, message_id: impl Into<MessageId>) -> Self

Links the subagent to the assistant message that held the spawning tool call, when the call sat in one.

Trait Implementations

impl Clone for SubagentStartedEvent

fn clone(&self) -> SubagentStartedEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for SubagentStartedEvent

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for SubagentStartedEvent

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

Formats the value using the given formatter.

impl Default for SubagentStartedEvent

fn default() -> SubagentStartedEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubagentStartedEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SubagentStartedEvent> for Event

fn from(payload: SubagentStartedEvent) -> Self

Converts to this type from the input type.

impl JsonSchema for SubagentStartedEvent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SubagentStartedEvent

fn eq(&self, other: &SubagentStartedEvent) -> 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 SubagentStartedEvent

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 SubagentStartedEvent

impl ToSchema for SubagentStartedEvent

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.