Skip to main content

EventKind

Enum EventKind 

Source
pub enum EventKind {
Show 119 variants RunStarted, RunCompleted, RunFailed, RunCancelled, RunCheckpointed, RunCancelRequested, RunResumeRequested, RunResumeFailed, TurnStarted, TurnCompleted, TurnFailed, MessageAccepted, MessageCommitted, ProviderRequestProjected, ModelAttemptStarted, ModelStreamDelta, ModelMessageCompleted, ModelAttemptFailed, ToolRequested, ToolStarted, ToolCompleted, ToolFailed, ToolDenied, ToolRecoveryRequired, ApprovalRequested, ApprovalDispatched, ApprovalDispatchUnavailable, ApprovalResponded, ApprovalDenied, ApprovalTimedOut, ApprovalCancelled, HookRegistered, HookInvoked, HookCompleted, HookFailed, HookTimedOut, HookCancelled, HookResponseApplied, HookResponseRejected, ContextAssembled, StreamRuleRegistered, StreamRuleCompileFailed, StreamRuleMatched, StreamInterventionRequested, StreamInterventionApplied, StreamRuleRepeatStateRecorded, RealtimeConnectRequested, RealtimeConnected, RealtimeInputSendRequested, RealtimeInputSent, RealtimeOutputReceiveRequested, RealtimeOutputReceived, RealtimeInterrupted, RealtimeRestartRequested, RealtimeRestartStarted, RealtimeRestartCompleted, RealtimeRestartFailed, RealtimeCloseRequested, RealtimeClosed, RealtimeBackpressureApplied, IsolationRequested, IsolationAdapterHealthChecked, IsolationCapabilityMatched, IsolationDowngradeDenied, IsolationDowngradeApproved, IsolationEnvironmentPrepared, IsolationProcessStarted, IsolationProcessIoCaptured, IsolationProcessStatsRecorded, IsolationCleanupStarted, IsolationCleanupCompleted, IsolationCleanupFailed, IsolationFailed, ChildLifecycleRequested, ChildLifecycleCompleted, ChildLifecycleDetached, SubagentStarted, SubagentHandoff, SubagentEventWrapped, SubagentUsageRolledUp, SubagentCompleted, ExtensionActionSubmitted, ExtensionActionStarted, ExtensionActionCompleted, ExtensionActionFailed, ExtensionActionDenied, OutputDispatchRequested, OutputDispatchCompleted, OutputDispatchFailed, OutputDispatchDeduped, StructuredOutputRequested, StructuredOutputValidationStarted, StructuredOutputValidationFailed, StructuredOutputRepairRequested, StructuredOutputValidated, StructuredOutputFailed, TelemetrySinkFailed, TelemetrySinkRecovered, UsageRecorded, CostEstimated, CostCorrected, ReplayStarted, ReplayCompleted, ReplayFailed, AgentPoolCreated, AgentPoolRunJoined, AgentPoolRunLeft, RunMessageAccepted, RunMessageDelivered, RunMessageResponded, RunMessageFailed, RunMessageTimedOut, RunMessageExpired, RunMessageCancelled, WakeConditionRegistered, WakeConditionTriggered, WakeConditionTimedOut, WakeConditionCancelled, WakeConditionFailed,
}
Expand description

Enumerates the finite event kind cases. Serialized names are part of the SDK contract; update fixtures when variants change.

Variants§

§

RunStarted

Use this variant when the contract needs to represent run started; selecting it has no side effect by itself.

§

RunCompleted

Use this variant when the contract needs to represent run completed; selecting it has no side effect by itself.

§

RunFailed

Use this variant when the contract needs to represent run failed; selecting it has no side effect by itself.

§

RunCancelled

Use this variant when the contract needs to represent run cancelled; selecting it has no side effect by itself.

§

RunCheckpointed

Use this variant when the contract needs to represent run checkpointed; selecting it has no side effect by itself.

§

RunCancelRequested

Use this variant when the contract needs to represent run cancel requested; selecting it has no side effect by itself.

§

RunResumeRequested

Use this variant when the contract needs to represent run resume requested; selecting it has no side effect by itself.

§

RunResumeFailed

Use this variant when the contract needs to represent run resume failed; selecting it has no side effect by itself.

§

TurnStarted

Use this variant when the contract needs to represent turn started; selecting it has no side effect by itself.

§

TurnCompleted

Use this variant when the contract needs to represent turn completed; selecting it has no side effect by itself.

§

TurnFailed

Use this variant when the contract needs to represent turn failed; selecting it has no side effect by itself.

§

MessageAccepted

Use this variant when the contract needs to represent message accepted; selecting it has no side effect by itself.

§

MessageCommitted

Use this variant when the contract needs to represent message committed; selecting it has no side effect by itself.

§

ProviderRequestProjected

Use this variant when the contract needs to represent provider request projected; selecting it has no side effect by itself.

§

ModelAttemptStarted

Use this variant when the contract needs to represent model attempt started; selecting it has no side effect by itself.

§

ModelStreamDelta

Use this variant when the contract needs to represent model stream delta; selecting it has no side effect by itself.

§

ModelMessageCompleted

Use this variant when the contract needs to represent model message completed; selecting it has no side effect by itself.

§

ModelAttemptFailed

Use this variant when the contract needs to represent model attempt failed; selecting it has no side effect by itself.

§

ToolRequested

Use this variant when the contract needs to represent tool requested; selecting it has no side effect by itself.

§

ToolStarted

Use this variant when the contract needs to represent tool started; selecting it has no side effect by itself.

§

ToolCompleted

Use this variant when the contract needs to represent tool completed; selecting it has no side effect by itself.

§

ToolFailed

Use this variant when the contract needs to represent tool failed; selecting it has no side effect by itself.

§

ToolDenied

Use this variant when the contract needs to represent tool denied; selecting it has no side effect by itself.

§

ToolRecoveryRequired

Use this variant when the contract needs to represent tool recovery required; selecting it has no side effect by itself.

§

ApprovalRequested

Use this variant when the contract needs to represent approval requested; selecting it has no side effect by itself.

§

ApprovalDispatched

Use this variant when the contract needs to represent approval dispatched; selecting it has no side effect by itself.

§

ApprovalDispatchUnavailable

Use this variant when the contract needs to represent approval dispatch unavailable; selecting it has no side effect by itself.

§

ApprovalResponded

Use this variant when the contract needs to represent approval responded; selecting it has no side effect by itself.

§

ApprovalDenied

Use this variant when the contract needs to represent approval denied; selecting it has no side effect by itself.

§

ApprovalTimedOut

Use this variant when the contract needs to represent approval timed out; selecting it has no side effect by itself.

§

ApprovalCancelled

Use this variant when the contract needs to represent approval cancelled; selecting it has no side effect by itself.

§

HookRegistered

Use this variant when the contract needs to represent hook registered; selecting it has no side effect by itself.

§

HookInvoked

Use this variant when the contract needs to represent hook invoked; selecting it has no side effect by itself.

§

HookCompleted

Use this variant when the contract needs to represent hook completed; selecting it has no side effect by itself.

§

HookFailed

Use this variant when the contract needs to represent hook failed; selecting it has no side effect by itself.

§

HookTimedOut

Use this variant when the contract needs to represent hook timed out; selecting it has no side effect by itself.

§

HookCancelled

Use this variant when the contract needs to represent hook cancelled; selecting it has no side effect by itself.

§

HookResponseApplied

Use this variant when the contract needs to represent hook response applied; selecting it has no side effect by itself.

§

HookResponseRejected

Use this variant when the contract needs to represent hook response rejected; selecting it has no side effect by itself.

§

ContextAssembled

Use this variant when the contract needs to represent context assembled; selecting it has no side effect by itself.

§

StreamRuleRegistered

Use this variant when the contract needs to represent stream rule registered; selecting it has no side effect by itself.

§

StreamRuleCompileFailed

Use this variant when the contract needs to represent stream rule compile failed; selecting it has no side effect by itself.

§

StreamRuleMatched

Use this variant when the contract needs to represent stream rule matched; selecting it has no side effect by itself.

§

StreamInterventionRequested

Use this variant when the contract needs to represent stream intervention requested; selecting it has no side effect by itself.

§

StreamInterventionApplied

Use this variant when the contract needs to represent stream intervention applied; selecting it has no side effect by itself.

§

StreamRuleRepeatStateRecorded

Use this variant when the contract needs to represent stream rule repeat state recorded; selecting it has no side effect by itself.

§

RealtimeConnectRequested

Use this variant when the contract needs to represent realtime connect requested; selecting it has no side effect by itself.

§

RealtimeConnected

Use this variant when the contract needs to represent realtime connected; selecting it has no side effect by itself.

§

RealtimeInputSendRequested

Use this variant when the contract needs to represent realtime input send requested; selecting it has no side effect by itself.

§

RealtimeInputSent

Use this variant when the contract needs to represent realtime input sent; selecting it has no side effect by itself.

§

RealtimeOutputReceiveRequested

Use this variant when the contract needs to represent realtime output receive requested; selecting it has no side effect by itself.

§

RealtimeOutputReceived

Use this variant when the contract needs to represent realtime output received; selecting it has no side effect by itself.

§

RealtimeInterrupted

Use this variant when the contract needs to represent realtime interrupted; selecting it has no side effect by itself.

§

RealtimeRestartRequested

Use this variant when the contract needs to represent realtime restart requested; selecting it has no side effect by itself.

§

RealtimeRestartStarted

Use this variant when the contract needs to represent realtime restart started; selecting it has no side effect by itself.

§

RealtimeRestartCompleted

Use this variant when the contract needs to represent realtime restart completed; selecting it has no side effect by itself.

§

RealtimeRestartFailed

Use this variant when the contract needs to represent realtime restart failed; selecting it has no side effect by itself.

§

RealtimeCloseRequested

Use this variant when the contract needs to represent realtime close requested; selecting it has no side effect by itself.

§

RealtimeClosed

Use this variant when the contract needs to represent realtime closed; selecting it has no side effect by itself.

§

RealtimeBackpressureApplied

Use this variant when the contract needs to represent realtime backpressure applied; selecting it has no side effect by itself.

§

IsolationRequested

Use this variant when the contract needs to represent isolation requested; selecting it has no side effect by itself.

§

IsolationAdapterHealthChecked

Use this variant when the contract needs to represent isolation adapter health checked; selecting it has no side effect by itself.

§

IsolationCapabilityMatched

Use this variant when the contract needs to represent isolation capability matched; selecting it has no side effect by itself.

§

IsolationDowngradeDenied

Use this variant when the contract needs to represent isolation downgrade denied; selecting it has no side effect by itself.

§

IsolationDowngradeApproved

Use this variant when the contract needs to represent isolation downgrade approved; selecting it has no side effect by itself.

§

IsolationEnvironmentPrepared

Use this variant when the contract needs to represent isolation environment prepared; selecting it has no side effect by itself.

§

IsolationProcessStarted

Use this variant when the contract needs to represent isolation process started; selecting it has no side effect by itself.

§

IsolationProcessIoCaptured

Use this variant when the contract needs to represent isolation process io captured; selecting it has no side effect by itself.

§

IsolationProcessStatsRecorded

Use this variant when the contract needs to represent isolation process stats recorded; selecting it has no side effect by itself.

§

IsolationCleanupStarted

Use this variant when the contract needs to represent isolation cleanup started; selecting it has no side effect by itself.

§

IsolationCleanupCompleted

Use this variant when the contract needs to represent isolation cleanup completed; selecting it has no side effect by itself.

§

IsolationCleanupFailed

Use this variant when the contract needs to represent isolation cleanup failed; selecting it has no side effect by itself.

§

IsolationFailed

Use this variant when the contract needs to represent isolation failed; selecting it has no side effect by itself.

§

ChildLifecycleRequested

Use this variant when the contract needs to represent child lifecycle requested; selecting it has no side effect by itself.

§

ChildLifecycleCompleted

Use this variant when the contract needs to represent child lifecycle completed; selecting it has no side effect by itself.

§

ChildLifecycleDetached

Use this variant when the contract needs to represent child lifecycle detached; selecting it has no side effect by itself.

§

SubagentStarted

Use this variant when the contract needs to represent subagent started; selecting it has no side effect by itself.

§

SubagentHandoff

Use this variant when the contract needs to represent subagent handoff; selecting it has no side effect by itself.

§

SubagentEventWrapped

Use this variant when the contract needs to represent subagent event wrapped; selecting it has no side effect by itself.

§

SubagentUsageRolledUp

Use this variant when the contract needs to represent subagent usage rolled up; selecting it has no side effect by itself.

§

SubagentCompleted

Use this variant when the contract needs to represent subagent completed; selecting it has no side effect by itself.

§

ExtensionActionSubmitted

Use this variant when the contract needs to represent extension action submitted; selecting it has no side effect by itself.

§

ExtensionActionStarted

Use this variant when the contract needs to represent extension action started; selecting it has no side effect by itself.

§

ExtensionActionCompleted

Use this variant when the contract needs to represent extension action completed; selecting it has no side effect by itself.

§

ExtensionActionFailed

Use this variant when the contract needs to represent extension action failed; selecting it has no side effect by itself.

§

ExtensionActionDenied

Use this variant when the contract needs to represent extension action denied; selecting it has no side effect by itself.

§

OutputDispatchRequested

Use this variant when the contract needs to represent output dispatch requested; selecting it has no side effect by itself.

§

OutputDispatchCompleted

Use this variant when the contract needs to represent output dispatch completed; selecting it has no side effect by itself.

§

OutputDispatchFailed

Use this variant when the contract needs to represent output dispatch failed; selecting it has no side effect by itself.

§

OutputDispatchDeduped

Use this variant when the contract needs to represent output dispatch deduped; selecting it has no side effect by itself.

§

StructuredOutputRequested

Use this variant when the contract needs to represent structured output requested; selecting it has no side effect by itself.

§

StructuredOutputValidationStarted

Use this variant when the contract needs to represent structured output validation started; selecting it has no side effect by itself.

§

StructuredOutputValidationFailed

Use this variant when the contract needs to represent structured output validation failed; selecting it has no side effect by itself.

§

StructuredOutputRepairRequested

Use this variant when the contract needs to represent structured output repair requested; selecting it has no side effect by itself.

§

StructuredOutputValidated

Use this variant when the contract needs to represent structured output validated; selecting it has no side effect by itself.

§

StructuredOutputFailed

Use this variant when the contract needs to represent structured output failed; selecting it has no side effect by itself.

§

TelemetrySinkFailed

Use this variant when the contract needs to represent telemetry sink failed; selecting it has no side effect by itself.

§

TelemetrySinkRecovered

Use this variant when the contract needs to represent telemetry sink recovered; selecting it has no side effect by itself.

§

UsageRecorded

Use this variant when the contract needs to represent usage recorded; selecting it has no side effect by itself.

§

CostEstimated

Use this variant when the contract needs to represent cost estimated; selecting it has no side effect by itself.

§

CostCorrected

Use this variant when the contract needs to represent cost corrected; selecting it has no side effect by itself.

§

ReplayStarted

Use this variant when the contract needs to represent replay started; selecting it has no side effect by itself.

§

ReplayCompleted

Use this variant when the contract needs to represent replay completed; selecting it has no side effect by itself.

§

ReplayFailed

Use this variant when the contract needs to represent replay failed; selecting it has no side effect by itself.

§

AgentPoolCreated

Use this variant when the contract needs to represent agent pool created; selecting it has no side effect by itself.

§

AgentPoolRunJoined

Use this variant when the contract needs to represent agent pool run joined; selecting it has no side effect by itself.

§

AgentPoolRunLeft

Use this variant when the contract needs to represent agent pool run left; selecting it has no side effect by itself.

§

RunMessageAccepted

Use this variant when the contract needs to represent run message accepted; selecting it has no side effect by itself.

§

RunMessageDelivered

Use this variant when the contract needs to represent run message delivered; selecting it has no side effect by itself.

§

RunMessageResponded

Use this variant when the contract needs to represent run message responded; selecting it has no side effect by itself.

§

RunMessageFailed

Use this variant when the contract needs to represent run message failed; selecting it has no side effect by itself.

§

RunMessageTimedOut

Use this variant when the contract needs to represent run message timed out; selecting it has no side effect by itself.

§

RunMessageExpired

Use this variant when the contract needs to represent run message expired; selecting it has no side effect by itself.

§

RunMessageCancelled

Use this variant when the contract needs to represent run message cancelled; selecting it has no side effect by itself.

§

WakeConditionRegistered

Use this variant when the contract needs to represent wake condition registered; selecting it has no side effect by itself.

§

WakeConditionTriggered

Use this variant when the contract needs to represent wake condition triggered; selecting it has no side effect by itself.

§

WakeConditionTimedOut

Use this variant when the contract needs to represent wake condition timed out; selecting it has no side effect by itself.

§

WakeConditionCancelled

Use this variant when the contract needs to represent wake condition cancelled; selecting it has no side effect by itself.

§

WakeConditionFailed

Use this variant when the contract needs to represent wake condition failed; selecting it has no side effect by itself.

Implementations§

Source§

impl EventKind

Source

pub fn is_terminal(&self) -> bool

Reports whether this value is terminal. The check is pure and does not mutate SDK or host state.

Trait Implementations§

Source§

impl Clone for EventKind

Source§

fn clone(&self) -> EventKind

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 EventKind

Source§

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

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

impl<'de> Deserialize<'de> for EventKind

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 Hash for EventKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for EventKind

Source§

fn cmp(&self, other: &EventKind) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for EventKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl PartialOrd for EventKind

Source§

fn partial_cmp(&self, other: &EventKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for EventKind

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

impl Eq for EventKind

Source§

impl StructuralPartialEq for EventKind

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,