Enum Event 

pub enum Event {
    ThreadStarted {
        thread_id: String,
    },
    TurnStarted,
    TurnCompleted {
        usage: Option<Usage>,
    },
    TurnFailed {
        usage: Option<Usage>,
        error: Option<ThreadError>,
    },
    ItemStarted {
        item: Item,
    },
    ItemUpdated {
        item: Item,
    },
    ItemCompleted {
        item: Item,
    },
    TokenCount {
        input_tokens: u64,
        cached_input_tokens: u64,
        output_tokens: u64,
    },
    Error {
        message: Option<String>,
    },
    Unknown,
}

A single JSONL event read from codex exec --json stdout.

Deserialized via #[serde(tag = "type")] so the "type" field selects the variant. Unknown event types deserialize as Event::Unknown.

Variants

ThreadStarted

A thread has been created for this execution.

Fields

thread_id: String

The thread identifier.

TurnStarted

A new turn has started.

TurnCompleted

A turn completed successfully.

Fields

usage: Option<Usage>

Token usage for this turn.

TurnFailed

A turn failed.

Fields

usage: Option<Usage>

Token usage for this turn (may still be reported on failure).

error: Option<ThreadError>

Error details.

ItemStarted

An item has started (message, command, file change, etc.).

Fields

item: Item

The item being started.

ItemUpdated

Incremental update to an in-flight item.

Fields

item: Item

The item with updated content.

ItemCompleted

An item has completed.

Fields

item: Item

The completed item.

TokenCount

Token usage statistics.

Fields

input_tokens: u64

Number of input tokens.

cached_input_tokens: u64

Number of cached input tokens.

output_tokens: u64

Number of output tokens.

Error

An execution-level error.

Fields

message: Option<String>

Error message.

Unknown

Forward-compatibility: any unrecognized event type.

Implementations

impl Event

pub fn is_thread_started(&self) -> bool

Returns true if this is a Event::ThreadStarted.

pub fn is_turn_completed(&self) -> bool

Returns true if this is a Event::TurnCompleted.

pub fn is_turn_failed(&self) -> bool

Returns true if this is a Event::TurnFailed.

pub fn is_error(&self) -> bool

Returns true if this is an Event::Error.

pub fn is_item_completed(&self) -> bool

Returns true if this is an Event::ItemCompleted.

pub fn item(&self) -> Option<&Item>

Extract the item from an ItemStarted, ItemUpdated, or ItemCompleted 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.