Skip to main content

qubit_http/sse/
sse_chunk.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026 Haixing Hu.
4 *
5 *    SPDX-License-Identifier: Apache-2.0
6 *
7 *    Licensed under the Apache License, Version 2.0.
8 *
9 ******************************************************************************/
10//! Decoded JSON chunk or explicit SSE stream end marker.
11//!
12
13use serde::{
14    Deserialize,
15    Serialize,
16};
17use strum::{
18    Display,
19    EnumString,
20};
21
22/// Either a decoded JSON value from one SSE data payload or an explicit end marker.
23#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Display, EnumString)]
24#[serde(bound(serialize = "T: serde::Serialize", deserialize = "T: serde::de::DeserializeOwned"))]
25#[serde(rename_all = "snake_case")]
26#[strum(serialize_all = "snake_case")]
27pub enum SseChunk<T> {
28    /// Successfully deserialized JSON object.
29    #[strum(disabled)]
30    Data(T),
31    /// Synthetic item emitted when [`DoneMarkerPolicy`](crate::sse::DoneMarkerPolicy)
32    /// matches (then stream ends).
33    Done,
34}