Enum ImageGenerationStreamEvent 

pub enum ImageGenerationStreamEvent {
    PartialImage {
        b64_json: String,
        background: OpenAiImageBackground,
        created_at: u64,
        output_format: OpenAiImageOutputFormat,
        partial_image_index: u32,
        quality: OpenAiImageQuality,
        size: OpenAiImageSize,
    },
    Completed {
        b64_json: String,
        background: OpenAiImageBackground,
        created_at: u64,
        output_format: OpenAiImageOutputFormat,
        quality: OpenAiImageQuality,
        size: OpenAiImageSize,
        usage: OpenAiImageUsage,
    },
    Error {
        error: OpenAiApiError,
    },
    Keepalive {
        sequence_number: Option<u64>,
    },
}

Stream event union documented by OpenAI image generation streaming.

Variants

PartialImage

Fields

b64_json: String

background: OpenAiImageBackground

created_at: u64

output_format: OpenAiImageOutputFormat

partial_image_index: u32

quality: OpenAiImageQuality

size: OpenAiImageSize

Completed

Fields

b64_json: String

background: OpenAiImageBackground

created_at: u64

output_format: OpenAiImageOutputFormat

quality: OpenAiImageQuality

size: OpenAiImageSize

usage: OpenAiImageUsage

Error

Fields

error: OpenAiApiError

Keepalive

Undocumented heartbeat frame some OpenAI-compatible backends ship mid-stream ({"type":"keepalive"}). Ignored during aggregation.

Fields

sequence_number: Option<u64>

Trait Implementations

impl Clone for ImageGenerationStreamEvent

fn clone(&self) -> ImageGenerationStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageGenerationStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageGenerationStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImageGenerationStreamEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ImageGenerationStreamEvent

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 ImageGenerationStreamEvent