Skip to main content

StreamEvent

gproxy_protocol::wire::openai::responses::stream

Enum StreamEvent

#[non_exhaustive]pub enum StreamEvent {
Show 54 variants    Keepalive,
    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(ResponseErrorEvent),
}

Expand description

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

This enum is marked as 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.

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(ResponseErrorEvent)

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. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for StreamEvent

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

Formats the value using the given formatter. Read more

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. Read more

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 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 ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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. Read more

impl StructuralPartialEq for StreamEvent

Auto Trait Implementations§

impl Freeze for StreamEvent

impl RefUnwindSafe for StreamEvent

impl Send for StreamEvent

impl Sync for StreamEvent

impl Unpin for StreamEvent

impl UnsafeUnpin for StreamEvent

impl UnwindSafe for StreamEvent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ResourceSend for T
where T: Send + ?Sized,

impl<T> ResourceSync for T
where T: Sync + ?Sized,

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.