Enum Event 

pub enum Event {
    Scope(ScopeEvent),
    Mark(MarkEvent),
}

Tagged union covering the two ATOF event kinds emitted by the runtime.

Variants

Scope(ScopeEvent)

Scope lifecycle event.

Mark(MarkEvent)

Point-in-time checkpoint event.

Implementations

impl Event

pub fn kind(&self) -> &'static str

Return the ATOF event kind.

Returns

"scope" for Event::Scope and "mark" for Event::Mark.

pub fn try_to_json_value(&self) -> Result<Value, Error>

Try to return this event as the canonical JSON object delivered by language bindings to subscriber callbacks and ATOF exporters.

pub fn to_json_value(&self) -> Value

Return this event as the canonical JSON object delivered by language bindings to subscriber callbacks.

pub fn to_json_string(&self) -> Result<String, Error>

Return this event as canonical JSON.

pub fn scope_category(&self) -> Option<ScopeCategory>

Return the lifecycle phase for scope events.

Returns

Some lifecycle phase for scope events, otherwise None.

pub fn category(&self) -> Option<&EventCategory>

Return the semantic category if present.

Returns

Some category for scope events and categorized mark events, otherwise None.

pub fn category_profile(&self) -> Option<&CategoryProfile>

Return the category-specific profile if present.

Returns

Some profile when category-specific fields are present.

pub fn category_profile_mut(&mut self) -> Option<&mut CategoryProfile>

Return the mutable category-specific profile if present.

Returns

Some mutable profile when category-specific fields are present.

pub fn parent_uuid(&self) -> Option<Uuid>

Return the parent scope UUID, if the event is nested under a scope.

Returns

Some parent UUID when the event has a parent scope, otherwise None.

pub fn uuid(&self) -> Uuid

Return the unique event or span UUID.

Returns

The event UUID.

pub fn timestamp(&self) -> &DateTime<Utc>

Return the event timestamp.

Returns

The UTC event timestamp.

pub fn name(&self) -> &str

Return the human-readable event name.

Returns

The event name.

pub fn data(&self) -> Option<&Value>

Return the optional application payload attached to the event.

Returns

Some payload when event data is present, otherwise None.

pub fn sanitize_fields(&self) -> EventSanitizeFields

Snapshot the observability fields that sanitizers may rewrite.

pub fn apply_sanitize_fields(&mut self, fields: EventSanitizeFields)

Replace the observability fields controlled by event sanitizers.

pub fn data_schema(&self) -> Option<&DataSchema>

Return the optional data schema.

Returns

Some schema when the event payload declares one, otherwise None.

pub fn metadata(&self) -> Option<&Value>

Return the optional metadata attached to the event.

Returns

Some metadata when present, otherwise None.

pub fn attributes(&self) -> Option<&[String]>

Return attributes for scope events.

Returns

Some attributes for scope events, otherwise None.

pub fn scope_type(&self) -> Option<ScopeType>

Return the semantic scope category for scope events.

Returns

Some legacy ScopeType when the event has a category.

pub fn input(&self) -> Option<&Value>

Return the semantic input payload for start events.

Returns

Some payload for scope-start events with data, otherwise None.

pub fn output(&self) -> Option<&Value>

Return the semantic output payload for end events.

Returns

Some payload for scope-end events with data, otherwise None.

pub fn model_name(&self) -> Option<&str>

Return the normalized model name for LLM events.

Returns

Some model name when the event profile includes one.

pub fn tool_call_id(&self) -> Option<&str>

Return the provider-specific tool-call correlation identifier.

Returns

Some tool call identifier when the event profile includes one.

pub fn annotated_request(&self) -> Option<&Arc<AnnotatedLlmRequest>>

Return the runtime-only annotated LLM request.

Returns

Some annotated request when the event profile includes one.

pub fn annotated_response(&self) -> Option<&Arc<AnnotatedLlmResponse>>

Return the runtime-only annotated LLM response.

Returns

Some annotated response when the event profile includes one.

pub fn is_scope_start(&self) -> bool

Return true for scope-start events.

Returns

true when the event is a scope-start event.

pub fn is_scope_end(&self) -> bool

Return true for scope-end events.

Returns

true when the event is a scope-end event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>( __deserializer: __D, ) -> Result<Event, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventNormalizationExt for Event

fn normalized_llm_request(&self) -> Option<Cow<'_, AnnotatedLlmRequest>>

Normalized LLM request: the codec annotation when present, otherwise a best-effort decode of the start-event input payload.

fn normalized_llm_response(&self) -> Option<Cow<'_, AnnotatedLlmResponse>>

Normalized LLM response: the codec annotation when present, otherwise a best-effort decode of the end-event output payload.

impl PartialEq for Event

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Event