Struct CustomEvent 

pub struct CustomEvent {
    pub base: BaseEvent,
    pub name: String,
    pub value: Value,
    pub subagent_run_id: Option<SubagentRunId>,
}

An application-defined event, outside the protocol’s vocabulary.

Use this for anything a specific client and agent agree on; the protocol only guarantees the envelope.

Fields

base: BaseEvent

Timestamp and raw provider event.

name: String

The event name both sides agreed on.

value: Value

The payload.

subagent_run_id: Option<SubagentRunId>

The subagent that produced this event; absent means the parent agent. A JSON null is rejected — see crate::event::subagent.

Implementations

impl CustomEvent

pub fn new(name: impl Into<String>, value: impl Into<Value>) -> Self

Emits a named custom event.

Trait Implementations

impl Clone for CustomEvent

fn clone(&self) -> CustomEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for CustomEvent

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

impl Debug for CustomEvent

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

Formats the value using the given formatter.

impl Default for CustomEvent

fn default() -> CustomEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CustomEvent> for Event

fn from(payload: CustomEvent) -> Self

Converts to this type from the input type.

impl JsonSchema for CustomEvent

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 CustomEvent

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

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 CustomEvent

impl ToSchema for CustomEvent

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.