#[non_exhaustive]pub enum ResponseEvent {
Show 48 variants
ResponseCreated(ResponseCreated),
ResponseInProgress(ResponseInProgress),
ResponseCompleted(ResponseCompleted),
ResponseFailed(ResponseFailed),
ResponseIncomplete(ResponseIncomplete),
ResponseQueued(ResponseQueued),
ResponseOutputItemAdded(ResponseOutputItemAdded),
ResponseContentPartAdded(ResponseContentPartAdded),
ResponseOutputTextDelta(ResponseOutputTextDelta),
ResponseOutputTextDone(ResponseOutputTextDone),
ResponseRefusalDelta(ResponseRefusalDelta),
ResponseRefusalDone(ResponseRefusalDone),
ResponseContentPartDone(ResponseContentPartDone),
ResponseOutputItemDone(ResponseOutputItemDone),
ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDelta),
ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDone),
ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgress),
ResponseFileSearchCallSearching(ResponseFileSearchCallSearching),
ResponseFileSearchCallCompleted(ResponseFileSearchCallCompleted),
ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgress),
ResponseWebSearchCallSearching(ResponseWebSearchCallSearching),
ResponseWebSearchCallCompleted(ResponseWebSearchCallCompleted),
ResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAdded),
ResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDone),
ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDelta),
ResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDone),
ResponseReasoningSummaryDelta(ResponseReasoningSummaryDelta),
ResponseReasoningSummaryDone(ResponseReasoningSummaryDone),
ResponseImageGenerationCallInProgress(ResponseImageGenerationCallInProgress),
ResponseImageGenerationCallGenerating(ResponseImageGenerationCallGenerating),
ResponseImageGenerationCallPartialImage(ResponseImageGenerationCallPartialImage),
ResponseImageGenerationCallCompleted(ResponseImageGenerationCallCompleted),
ResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDelta),
ResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDone),
ResponseMcpCallCompleted(ResponseMcpCallCompleted),
ResponseMcpCallFailed(ResponseMcpCallFailed),
ResponseMcpCallInProgress(ResponseMcpCallInProgress),
ResponseMcpListToolsCompleted(ResponseMcpListToolsCompleted),
ResponseMcpListToolsFailed(ResponseMcpListToolsFailed),
ResponseMcpListToolsInProgress(ResponseMcpListToolsInProgress),
ResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgress),
ResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpreting),
ResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompleted),
ResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDelta),
ResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDone),
ResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAdded),
ResponseError(ResponseError),
Unknown(Value),
}Expand description
Event types for streaming responses from the Responses API
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.
ResponseCreated(ResponseCreated)
Response creation started
ResponseInProgress(ResponseInProgress)
Processing in progress
ResponseCompleted(ResponseCompleted)
Response completed (different from done)
ResponseFailed(ResponseFailed)
Response failed
ResponseIncomplete(ResponseIncomplete)
Response incomplete
ResponseQueued(ResponseQueued)
Response queued
ResponseOutputItemAdded(ResponseOutputItemAdded)
Output item added
ResponseContentPartAdded(ResponseContentPartAdded)
Content part added
ResponseOutputTextDelta(ResponseOutputTextDelta)
Text delta update
ResponseOutputTextDone(ResponseOutputTextDone)
Text output completed
ResponseRefusalDelta(ResponseRefusalDelta)
Refusal delta update
ResponseRefusalDone(ResponseRefusalDone)
Refusal completed
ResponseContentPartDone(ResponseContentPartDone)
Content part completed
ResponseOutputItemDone(ResponseOutputItemDone)
Output item completed
ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDelta)
Function call arguments delta
ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDone)
Function call arguments completed
ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgress)
File search call in progress
ResponseFileSearchCallSearching(ResponseFileSearchCallSearching)
File search call searching
ResponseFileSearchCallCompleted(ResponseFileSearchCallCompleted)
File search call completed
ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgress)
Web search call in progress
ResponseWebSearchCallSearching(ResponseWebSearchCallSearching)
Web search call searching
ResponseWebSearchCallCompleted(ResponseWebSearchCallCompleted)
Web search call completed
ResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAdded)
Reasoning summary part added
ResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDone)
Reasoning summary part done
ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDelta)
Reasoning summary text delta
ResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDone)
Reasoning summary text done
ResponseReasoningSummaryDelta(ResponseReasoningSummaryDelta)
Reasoning summary delta
ResponseReasoningSummaryDone(ResponseReasoningSummaryDone)
Reasoning summary done
ResponseImageGenerationCallInProgress(ResponseImageGenerationCallInProgress)
Image generation call in progress
ResponseImageGenerationCallGenerating(ResponseImageGenerationCallGenerating)
Image generation call generating
ResponseImageGenerationCallPartialImage(ResponseImageGenerationCallPartialImage)
Image generation call partial image
ResponseImageGenerationCallCompleted(ResponseImageGenerationCallCompleted)
Image generation call completed
ResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDelta)
MCP call arguments delta
ResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDone)
MCP call arguments done
ResponseMcpCallCompleted(ResponseMcpCallCompleted)
MCP call completed
ResponseMcpCallFailed(ResponseMcpCallFailed)
MCP call failed
ResponseMcpCallInProgress(ResponseMcpCallInProgress)
MCP call in progress
ResponseMcpListToolsCompleted(ResponseMcpListToolsCompleted)
MCP list tools completed
ResponseMcpListToolsFailed(ResponseMcpListToolsFailed)
MCP list tools failed
ResponseMcpListToolsInProgress(ResponseMcpListToolsInProgress)
MCP list tools in progress
ResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgress)
Code interpreter call in progress
ResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpreting)
Code interpreter call interpreting
ResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompleted)
Code interpreter call completed
ResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDelta)
Code interpreter call code delta
ResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDone)
Code interpreter call code done
ResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAdded)
Output text annotation added
ResponseError(ResponseError)
Error occurred
Unknown(Value)
Unknown event type
Trait Implementations§
Source§impl Clone for ResponseEvent
impl Clone for ResponseEvent
Source§fn clone(&self) -> ResponseEvent
fn clone(&self) -> ResponseEvent
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for ResponseEvent
impl Debug for ResponseEvent
Source§impl<'de> Deserialize<'de> for ResponseEvent
impl<'de> Deserialize<'de> for ResponseEvent
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<ResponseEvent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<ResponseEvent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for ResponseEvent
impl PartialEq for ResponseEvent
Source§impl Serialize for ResponseEvent
impl Serialize for ResponseEvent
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
impl StructuralPartialEq for ResponseEvent
Auto Trait Implementations§
impl Freeze for ResponseEvent
impl RefUnwindSafe for ResponseEvent
impl Send for ResponseEvent
impl Sync for ResponseEvent
impl Unpin for ResponseEvent
impl UnwindSafe for ResponseEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Change the foreground color to black
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Change the background color to black
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Change the foreground color to red
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Change the background color to red
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Change the foreground color to green
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Change the background color to green
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Change the foreground color to yellow
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Change the background color to yellow
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Change the foreground color to blue
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Change the background color to blue
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to magenta
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to magenta
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to purple
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to purple
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Change the foreground color to cyan
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Change the background color to cyan
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Change the foreground color to white
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Change the background color to white
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Change the foreground color to the terminal default
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Change the background color to the terminal default
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Change the foreground color to bright black
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Change the background color to bright black
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Change the foreground color to bright red
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Change the background color to bright red
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Change the foreground color to bright green
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Change the background color to bright green
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Change the foreground color to bright yellow
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Change the background color to bright yellow
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Change the foreground color to bright blue
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Change the background color to bright blue
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright magenta
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright magenta
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright purple
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright purple
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Change the foreground color to bright cyan
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Change the background color to bright cyan
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Change the foreground color to bright white
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Change the background color to bright white
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Make the text bold
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Make the text dim
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Make the text italicized
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Make the text underlined
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Make the text blink
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Make the text blink (but fast!)
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Swap the foreground and background colors
Hide the text
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Cross out the text
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either
OwoColorize::fg or
a color-specific method, such as OwoColorize::green, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either
OwoColorize::bg or
a color-specific method, such as OwoColorize::on_yellow, Read moreSource§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
Source§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
Source§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
Source§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.