Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    Keepalive,
    Metadata(ResponseMetadata),
    Created(ResponseCreated),
    Queued(ResponseQueued),
    InProgress(ResponseInProgress),
    Completed(ResponseCompleted),
    Failed(ResponseFailed),
    Incomplete(ResponseIncomplete),
    OutputItemAdded(OutputItemEvent),
    OutputItemDone(OutputItemEvent),
    ContentPartAdded(ContentPartEvent),
    ContentPartDone(ContentPartEvent),
    OutputTextDelta(OutputTextDelta),
    OutputTextDone(OutputTextDone),
    OutputTextAnnotationAdded(OutputTextAnnotationAdded),
    RefusalDelta(RefusalDelta),
    RefusalDone(RefusalDone),
    ReasoningTextDelta(ReasoningTextDelta),
    ReasoningTextDone(ReasoningTextDone),
    ReasoningSummaryPartAdded(ReasoningSummaryPartAddedEvent),
    ReasoningSummaryPartDone(ReasoningSummaryPartDoneEvent),
    ReasoningSummaryTextDelta(ReasoningSummaryTextDelta),
    ReasoningSummaryTextDone(ReasoningSummaryTextDone),
    FunctionCallArgumentsDelta(FunctionCallArgumentsDelta),
    FunctionCallArgumentsDone(FunctionCallArgumentsDone),
    CustomToolInputDelta(CustomToolInputDelta),
    CustomToolInputDone(CustomToolInputDone),
    CodeInterpreterCodeDelta(CodeInterpreterCodeDelta),
    CodeInterpreterCodeDone(CodeInterpreterCodeDone),
    AudioDelta(AudioDelta),
    AudioDone(AudioDone),
    AudioTranscriptDelta(AudioTranscriptDelta),
    AudioTranscriptDone(AudioTranscriptDone),
    ImagePartial(ImagePartial),
    ImageCall(ImageCallEvent),
    ImageGenerating(ImageCallEvent),
    ImageCompleted(ImageCallEvent),
    CodeInterpreterInProgress(CodeInterpreterEvent),
    CodeInterpreterInterpreting(CodeInterpreterEvent),
    CodeInterpreterCompleted(CodeInterpreterEvent),
    FileSearchInProgress(ToolCallEvent),
    FileSearchSearching(ToolCallEvent),
    FileSearchCompleted(ToolCallEvent),
    WebSearchInProgress(ToolCallEvent),
    WebSearchSearching(ToolCallEvent),
    WebSearchCompleted(ToolCallEvent),
    McpArgumentsDelta(McpArgumentsDelta),
    McpArgumentsDone(McpArgumentsDone),
    McpInProgress(McpCallEvent),
    McpCompleted(McpCallEvent),
    McpFailed(McpCallEvent),
    McpListToolsInProgress(McpListToolsEvent),
    McpListToolsCompleted(McpListToolsEvent),
    McpListToolsFailed(McpListToolsEvent),
    Error(ResponseStreamError),
    Unknown,
}

Typed payloads for the HTTP Responses SSE stream. SSE framing and [DONE] handling remain transport concerns; this enum only represents JSON data.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Keepalive

Undocumented upstream heartbeat; converted to Claude ping or otherwise ignored.

Metadata(ResponseMetadata)

Out-of-band response metadata emitted by the Codex Responses backend.

Created(ResponseCreated)

Queued(ResponseQueued)

InProgress(ResponseInProgress)

Completed(ResponseCompleted)

Failed(ResponseFailed)

Incomplete(ResponseIncomplete)

OutputItemAdded(OutputItemEvent)

OutputItemDone(OutputItemEvent)

ContentPartAdded(ContentPartEvent)

ContentPartDone(ContentPartEvent)

OutputTextDelta(OutputTextDelta)

OutputTextDone(OutputTextDone)

OutputTextAnnotationAdded(OutputTextAnnotationAdded)

RefusalDelta(RefusalDelta)

RefusalDone(RefusalDone)

ReasoningTextDelta(ReasoningTextDelta)

ReasoningTextDone(ReasoningTextDone)

ReasoningSummaryPartAdded(ReasoningSummaryPartAddedEvent)

ReasoningSummaryPartDone(ReasoningSummaryPartDoneEvent)

ReasoningSummaryTextDelta(ReasoningSummaryTextDelta)

ReasoningSummaryTextDone(ReasoningSummaryTextDone)

FunctionCallArgumentsDelta(FunctionCallArgumentsDelta)

FunctionCallArgumentsDone(FunctionCallArgumentsDone)

CustomToolInputDelta(CustomToolInputDelta)

CustomToolInputDone(CustomToolInputDone)

CodeInterpreterCodeDelta(CodeInterpreterCodeDelta)

CodeInterpreterCodeDone(CodeInterpreterCodeDone)

AudioDelta(AudioDelta)

AudioDone(AudioDone)

AudioTranscriptDelta(AudioTranscriptDelta)

AudioTranscriptDone(AudioTranscriptDone)

ImagePartial(ImagePartial)

ImageCall(ImageCallEvent)

ImageGenerating(ImageCallEvent)

ImageCompleted(ImageCallEvent)

CodeInterpreterInProgress(CodeInterpreterEvent)

CodeInterpreterInterpreting(CodeInterpreterEvent)

CodeInterpreterCompleted(CodeInterpreterEvent)

FileSearchInProgress(ToolCallEvent)

FileSearchSearching(ToolCallEvent)

FileSearchCompleted(ToolCallEvent)

WebSearchInProgress(ToolCallEvent)

WebSearchSearching(ToolCallEvent)

WebSearchCompleted(ToolCallEvent)

McpArgumentsDelta(McpArgumentsDelta)

McpArgumentsDone(McpArgumentsDone)

McpInProgress(McpCallEvent)

McpCompleted(McpCallEvent)

McpFailed(McpCallEvent)

McpListToolsInProgress(McpListToolsEvent)

McpListToolsCompleted(McpListToolsEvent)

McpListToolsFailed(McpListToolsEvent)

Error(ResponseStreamError)

Unknown

A future event type is ignored by converters. Known event payloads remain strict. Native passthrough retains the original bytes rather than this marker.

Implementations

impl StreamEvent

pub fn agent(&self) -> Option<&Agent>

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl DeclaredFields for StreamEvent

fn into_declared(self) -> Self

impl<'de> Deserialize<'de> for StreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NativeEvent for StreamEvent

const DIALECT: Dialect = Dialect::OpenAi

type Full = GenerateContentResponseBody

type Collector = ResponsesStreamCollector

fn responses_history(value: &Self::Full) -> Option<&GenerateContentResponseBody>

fn collector( _: IdentityFlow, _: TargetIdPolicy, limits: EventLimits, ) -> Self::Collector

fn collect( collector: &mut Self::Collector, event: Self, ) -> Result<(), TransformError>

fn collected( collector: Self::Collector, ) -> Result<Converted<Collected<Self::Full>>, TransformError>

fn event_name(&self) -> Option<&'static str>

fn is_terminal(&self) -> bool

fn tool_declarations( &self, _complete_tool_names: bool, ) -> Vec<(String, ToolCallKind, Option<String>)>

Complete emitted ID, actual call kind, and complete name if already known.

const DONE: bool = false

fn decode(value: Value) -> Result<Self, TransformError>

fn collect_done(_collector: &mut Self::Collector) -> Result<(), TransformError>

fn is_usage_only(&self) -> bool

impl PartialEq for StreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StreamEvent

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 StreamEvent