RubyGems - spikard - Versions diffs - 0.3.2 → 0.3.3 - Mend

spikard 0.3.2 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (180) hide show

checksums.yaml +4 -4
data/LICENSE +1 -1
data/README.md +659 -659
data/ext/spikard_rb/Cargo.toml +17 -17
data/ext/spikard_rb/extconf.rb +10 -10
data/ext/spikard_rb/src/lib.rs +6 -6
data/lib/spikard/app.rb +386 -386
data/lib/spikard/background.rb +27 -27
data/lib/spikard/config.rb +396 -396
data/lib/spikard/converters.rb +13 -13
data/lib/spikard/handler_wrapper.rb +113 -113
data/lib/spikard/provide.rb +214 -214
data/lib/spikard/response.rb +173 -173
data/lib/spikard/schema.rb +243 -243
data/lib/spikard/sse.rb +111 -111
data/lib/spikard/streaming_response.rb +44 -44
data/lib/spikard/testing.rb +221 -221
data/lib/spikard/upload_file.rb +131 -131
data/lib/spikard/version.rb +5 -5
data/lib/spikard/websocket.rb +59 -59
data/lib/spikard.rb +43 -43
data/sig/spikard.rbs +360 -360
data/vendor/crates/spikard-core/Cargo.toml +40 -40
data/vendor/crates/spikard-core/src/bindings/mod.rs +3 -3
data/vendor/crates/spikard-core/src/bindings/response.rs +133 -133
data/vendor/crates/spikard-core/src/debug.rs +63 -63
data/vendor/crates/spikard-core/src/di/container.rs +726 -726
data/vendor/crates/spikard-core/src/di/dependency.rs +273 -273
data/vendor/crates/spikard-core/src/di/error.rs +118 -118
data/vendor/crates/spikard-core/src/di/factory.rs +538 -538
data/vendor/crates/spikard-core/src/di/graph.rs +545 -545
data/vendor/crates/spikard-core/src/di/mod.rs +192 -192
data/vendor/crates/spikard-core/src/di/resolved.rs +411 -411
data/vendor/crates/spikard-core/src/di/value.rs +283 -283
data/vendor/crates/spikard-core/src/errors.rs +39 -39
data/vendor/crates/spikard-core/src/http.rs +153 -153
data/vendor/crates/spikard-core/src/lib.rs +29 -29
data/vendor/crates/spikard-core/src/lifecycle.rs +422 -422
data/vendor/crates/spikard-core/src/parameters.rs +722 -722
data/vendor/crates/spikard-core/src/problem.rs +310 -310
data/vendor/crates/spikard-core/src/request_data.rs +189 -189
data/vendor/crates/spikard-core/src/router.rs +249 -249
data/vendor/crates/spikard-core/src/schema_registry.rs +183 -183
data/vendor/crates/spikard-core/src/type_hints.rs +304 -304
data/vendor/crates/spikard-core/src/validation.rs +699 -699
data/vendor/crates/spikard-http/Cargo.toml +58 -58
data/vendor/crates/spikard-http/src/auth.rs +247 -247
data/vendor/crates/spikard-http/src/background.rs +249 -249
data/vendor/crates/spikard-http/src/bindings/mod.rs +3 -3
data/vendor/crates/spikard-http/src/bindings/response.rs +1 -1
data/vendor/crates/spikard-http/src/body_metadata.rs +8 -8
data/vendor/crates/spikard-http/src/cors.rs +490 -490
data/vendor/crates/spikard-http/src/debug.rs +63 -63
data/vendor/crates/spikard-http/src/di_handler.rs +423 -423
data/vendor/crates/spikard-http/src/handler_response.rs +190 -190
data/vendor/crates/spikard-http/src/handler_trait.rs +228 -228
data/vendor/crates/spikard-http/src/handler_trait_tests.rs +284 -284
data/vendor/crates/spikard-http/src/lib.rs +529 -529
data/vendor/crates/spikard-http/src/lifecycle/adapter.rs +149 -149
data/vendor/crates/spikard-http/src/lifecycle.rs +428 -428
data/vendor/crates/spikard-http/src/middleware/mod.rs +285 -285
data/vendor/crates/spikard-http/src/middleware/multipart.rs +86 -86
data/vendor/crates/spikard-http/src/middleware/urlencoded.rs +147 -147
data/vendor/crates/spikard-http/src/middleware/validation.rs +287 -287
data/vendor/crates/spikard-http/src/openapi/mod.rs +309 -309
data/vendor/crates/spikard-http/src/openapi/parameter_extraction.rs +190 -190
data/vendor/crates/spikard-http/src/openapi/schema_conversion.rs +308 -308
data/vendor/crates/spikard-http/src/openapi/spec_generation.rs +195 -195
data/vendor/crates/spikard-http/src/parameters.rs +1 -1
data/vendor/crates/spikard-http/src/problem.rs +1 -1
data/vendor/crates/spikard-http/src/query_parser.rs +369 -369
data/vendor/crates/spikard-http/src/response.rs +399 -399
data/vendor/crates/spikard-http/src/router.rs +1 -1
data/vendor/crates/spikard-http/src/schema_registry.rs +1 -1
data/vendor/crates/spikard-http/src/server/handler.rs +87 -87
data/vendor/crates/spikard-http/src/server/lifecycle_execution.rs +98 -98
data/vendor/crates/spikard-http/src/server/mod.rs +805 -805
data/vendor/crates/spikard-http/src/server/request_extraction.rs +119 -119
data/vendor/crates/spikard-http/src/sse.rs +447 -447
data/vendor/crates/spikard-http/src/testing/form.rs +14 -14
data/vendor/crates/spikard-http/src/testing/multipart.rs +60 -60
data/vendor/crates/spikard-http/src/testing/test_client.rs +285 -285
data/vendor/crates/spikard-http/src/testing.rs +377 -377
data/vendor/crates/spikard-http/src/type_hints.rs +1 -1
data/vendor/crates/spikard-http/src/validation.rs +1 -1
data/vendor/crates/spikard-http/src/websocket.rs +324 -324
data/vendor/crates/spikard-rb/Cargo.toml +42 -42
data/vendor/crates/spikard-rb/build.rs +8 -8
data/vendor/crates/spikard-rb/src/background.rs +63 -63
data/vendor/crates/spikard-rb/src/config.rs +294 -294
data/vendor/crates/spikard-rb/src/conversion.rs +453 -453
data/vendor/crates/spikard-rb/src/di.rs +409 -409
data/vendor/crates/spikard-rb/src/handler.rs +625 -625
data/vendor/crates/spikard-rb/src/lib.rs +2771 -2771
data/vendor/crates/spikard-rb/src/lifecycle.rs +274 -274
data/vendor/crates/spikard-rb/src/server.rs +283 -283
data/vendor/crates/spikard-rb/src/sse.rs +231 -231
data/vendor/crates/spikard-rb/src/test_client.rs +404 -404
data/vendor/crates/spikard-rb/src/test_sse.rs +143 -143
data/vendor/crates/spikard-rb/src/test_websocket.rs +221 -221
data/vendor/crates/spikard-rb/src/websocket.rs +233 -233
data/vendor/spikard-core/Cargo.toml +40 -40
data/vendor/spikard-core/src/bindings/mod.rs +3 -3
data/vendor/spikard-core/src/bindings/response.rs +133 -133
data/vendor/spikard-core/src/debug.rs +63 -63
data/vendor/spikard-core/src/di/container.rs +726 -726
data/vendor/spikard-core/src/di/dependency.rs +273 -273
data/vendor/spikard-core/src/di/error.rs +118 -118
data/vendor/spikard-core/src/di/factory.rs +538 -538
data/vendor/spikard-core/src/di/graph.rs +545 -545
data/vendor/spikard-core/src/di/mod.rs +192 -192
data/vendor/spikard-core/src/di/resolved.rs +411 -411
data/vendor/spikard-core/src/di/value.rs +283 -283
data/vendor/spikard-core/src/http.rs +153 -153
data/vendor/spikard-core/src/lib.rs +28 -28
data/vendor/spikard-core/src/lifecycle.rs +422 -422
data/vendor/spikard-core/src/parameters.rs +719 -719
data/vendor/spikard-core/src/problem.rs +310 -310
data/vendor/spikard-core/src/request_data.rs +189 -189
data/vendor/spikard-core/src/router.rs +249 -249
data/vendor/spikard-core/src/schema_registry.rs +183 -183
data/vendor/spikard-core/src/type_hints.rs +304 -304
data/vendor/spikard-core/src/validation.rs +699 -699
data/vendor/spikard-http/Cargo.toml +58 -58
data/vendor/spikard-http/src/auth.rs +247 -247
data/vendor/spikard-http/src/background.rs +249 -249
data/vendor/spikard-http/src/bindings/mod.rs +3 -3
data/vendor/spikard-http/src/bindings/response.rs +1 -1
data/vendor/spikard-http/src/body_metadata.rs +8 -8
data/vendor/spikard-http/src/cors.rs +490 -490
data/vendor/spikard-http/src/debug.rs +63 -63
data/vendor/spikard-http/src/di_handler.rs +423 -423
data/vendor/spikard-http/src/handler_response.rs +190 -190
data/vendor/spikard-http/src/handler_trait.rs +228 -228
data/vendor/spikard-http/src/handler_trait_tests.rs +284 -284
data/vendor/spikard-http/src/lib.rs +529 -529
data/vendor/spikard-http/src/lifecycle/adapter.rs +149 -149
data/vendor/spikard-http/src/lifecycle.rs +428 -428
data/vendor/spikard-http/src/middleware/mod.rs +285 -285
data/vendor/spikard-http/src/middleware/multipart.rs +86 -86
data/vendor/spikard-http/src/middleware/urlencoded.rs +147 -147
data/vendor/spikard-http/src/middleware/validation.rs +287 -287
data/vendor/spikard-http/src/openapi/mod.rs +309 -309
data/vendor/spikard-http/src/openapi/parameter_extraction.rs +190 -190
data/vendor/spikard-http/src/openapi/schema_conversion.rs +308 -308
data/vendor/spikard-http/src/openapi/spec_generation.rs +195 -195
data/vendor/spikard-http/src/parameters.rs +1 -1
data/vendor/spikard-http/src/problem.rs +1 -1
data/vendor/spikard-http/src/query_parser.rs +369 -369
data/vendor/spikard-http/src/response.rs +399 -399
data/vendor/spikard-http/src/router.rs +1 -1
data/vendor/spikard-http/src/schema_registry.rs +1 -1
data/vendor/spikard-http/src/server/handler.rs +80 -80
data/vendor/spikard-http/src/server/lifecycle_execution.rs +98 -98
data/vendor/spikard-http/src/server/mod.rs +805 -805
data/vendor/spikard-http/src/server/request_extraction.rs +119 -119
data/vendor/spikard-http/src/sse.rs +447 -447
data/vendor/spikard-http/src/testing/form.rs +14 -14
data/vendor/spikard-http/src/testing/multipart.rs +60 -60
data/vendor/spikard-http/src/testing/test_client.rs +285 -285
data/vendor/spikard-http/src/testing.rs +377 -377
data/vendor/spikard-http/src/type_hints.rs +1 -1
data/vendor/spikard-http/src/validation.rs +1 -1
data/vendor/spikard-http/src/websocket.rs +324 -324
data/vendor/spikard-rb/Cargo.toml +42 -42
data/vendor/spikard-rb/build.rs +8 -8
data/vendor/spikard-rb/src/background.rs +63 -63
data/vendor/spikard-rb/src/config.rs +294 -294
data/vendor/spikard-rb/src/conversion.rs +392 -392
data/vendor/spikard-rb/src/di.rs +409 -409
data/vendor/spikard-rb/src/handler.rs +534 -534
data/vendor/spikard-rb/src/lib.rs +2020 -2020
data/vendor/spikard-rb/src/lifecycle.rs +267 -267
data/vendor/spikard-rb/src/server.rs +283 -283
data/vendor/spikard-rb/src/sse.rs +231 -231
data/vendor/spikard-rb/src/test_client.rs +404 -404
data/vendor/spikard-rb/src/test_sse.rs +143 -143
data/vendor/spikard-rb/src/test_websocket.rs +221 -221
data/vendor/spikard-rb/src/websocket.rs +233 -233
metadata +1 -1

data/vendor/crates/spikard-http/src/handler_response.rs CHANGED Viewed

@@ -1,190 +1,190 @@
-use axum::{
-    BoxError,
-    body::Body,
-    http::{HeaderMap, HeaderName, HeaderValue, StatusCode},
-    response::Response as AxumResponse,
-};
-use bytes::Bytes;
-use futures::{Stream, StreamExt};
-use std::pin::Pin;
-/// Unified response type that can represent either a ready response or a streaming body.
-///
-/// This enum allows handlers to return either:
-/// - A complete response that's ready to send (`Response` variant)
-/// - A streaming response with potentially unbounded data (`Stream` variant)
-///
-/// # Variants
-///
-/// * `Response` - A complete Axum response ready to send to the client. Use this for
-///   responses where you have all the data ready (files, JSON bodies, HTML, etc.)
-///
-/// * `Stream` - A streaming response that produces data chunks over time. Use this for:
-///   - Large files (avoid loading entire file in memory)
-///   - Server-Sent Events (SSE)
-///   - Long-polling responses
-///   - Real-time data feeds
-///   - Any unbounded or very large responses
-///
-/// # Examples
-///
-/// ```ignore
-/// // Regular response
-/// let response = AxumResponse::builder()
-///     .status(StatusCode::OK)
-///     .body(Body::from("Hello"))
-///     .unwrap();
-/// let handler_response = HandlerResponse::from(response);
-///
-/// // Streaming response
-/// let stream = futures::stream::iter(vec![
-///     Ok::<_, Box<dyn std::error::Error>>(Bytes::from("chunk1")),
-///     Ok(Bytes::from("chunk2")),
-/// ]);
-/// let response = HandlerResponse::stream(stream)
-///     .with_status(StatusCode::OK);
-/// ```
-pub enum HandlerResponse {
-    /// A complete response ready to send
-    Response(AxumResponse<Body>),
-    /// A streaming response with custom status and headers
-    Stream {
-        /// The byte stream that will be sent to the client
-        stream: Pin<Box<dyn Stream<Item = Result<Bytes, BoxError>> + Send + 'static>>,
-        /// HTTP status code for the response
-        status: StatusCode,
-        /// Response headers to send
-        headers: HeaderMap,
-    },
-}
-impl From<AxumResponse<Body>> for HandlerResponse {
-    fn from(response: AxumResponse<Body>) -> Self {
-        HandlerResponse::Response(response)
-    }
-}
-impl HandlerResponse {
-    /// Convert the handler response into an Axum response.
-    ///
-    /// Consumes the `HandlerResponse` and produces an `AxumResponse<Body>` ready
-    /// to be sent to the client. For streaming responses, wraps the stream in an
-    /// Axum Body.
-    ///
-    /// # Returns
-    /// An `AxumResponse<Body>` ready to be returned from an Axum handler
-    pub fn into_response(self) -> AxumResponse<Body> {
-        match self {
-            HandlerResponse::Response(response) => response,
-            HandlerResponse::Stream {
-                stream,
-                status,
-                mut headers,
-            } => {
-                let body = Body::from_stream(stream);
-                let mut response = AxumResponse::new(body);
-                *response.status_mut() = status;
-                response.headers_mut().extend(headers.drain());
-                response
-            }
-        }
-    }
-    /// Create a streaming response from any async stream of byte chunks.
-    ///
-    /// Wraps an async stream of byte chunks into a `HandlerResponse::Stream`.
-    /// This is useful for large files, real-time data, or any unbounded response.
-    ///
-    /// # Type Parameters
-    /// * `S` - The stream type implementing `Stream<Item = Result<Bytes, E>>`
-    /// * `E` - The error type that can be converted to `BoxError`
-    ///
-    /// # Arguments
-    /// * `stream` - An async stream that yields byte chunks or errors
-    ///
-    /// # Returns
-    /// A `HandlerResponse` with 200 OK status and empty headers (customize with
-    /// `with_status()` and `with_header()`)
-    ///
-    /// # Example
-    ///
-    /// ```ignore
-    /// use futures::stream;
-    /// use spikard_http::HandlerResponse;
-    /// use bytes::Bytes;
-    ///
-    /// let stream = stream::iter(vec![
-    ///     Ok::<_, Box<dyn std::error::Error>>(Bytes::from("Hello ")),
-    ///     Ok(Bytes::from("World")),
-    /// ]);
-    /// let response = HandlerResponse::stream(stream)
-    ///     .with_status(StatusCode::OK);
-    /// ```
-    pub fn stream<S, E>(stream: S) -> Self
-    where
-        S: Stream<Item = Result<Bytes, E>> + Send + 'static,
-        E: Into<BoxError>,
-    {
-        let mapped = stream.map(|chunk| chunk.map_err(Into::into));
-        HandlerResponse::Stream {
-            stream: Box::pin(mapped),
-            status: StatusCode::OK,
-            headers: HeaderMap::new(),
-        }
-    }
-    /// Override the HTTP status code for the streaming response.
-    ///
-    /// Sets the HTTP status code to be used in the response. This only affects
-    /// `Stream` variants; regular responses already have their status set.
-    ///
-    /// # Arguments
-    /// * `status` - The HTTP status code to use (e.g., `StatusCode::OK`)
-    ///
-    /// # Returns
-    /// Self for method chaining
-    ///
-    /// # Example
-    ///
-    /// ```ignore
-    /// let response = HandlerResponse::stream(my_stream)
-    ///     .with_status(StatusCode::PARTIAL_CONTENT);
-    /// ```
-    pub fn with_status(mut self, status: StatusCode) -> Self {
-        if let HandlerResponse::Stream { status: s, .. } = &mut self {
-            *s = status;
-        }
-        self
-    }
-    /// Insert or replace a header on the streaming response.
-    ///
-    /// Adds an HTTP header to the response. This only affects `Stream` variants;
-    /// regular responses already have their headers set. If a header with the same
-    /// name already exists, it will be replaced.
-    ///
-    /// # Arguments
-    /// * `name` - The header name (e.g., `HeaderName::from_static("content-type")`)
-    /// * `value` - The header value
-    ///
-    /// # Returns
-    /// Self for method chaining
-    ///
-    /// # Example
-    ///
-    /// ```ignore
-    /// use axum::http::{HeaderName, HeaderValue};
-    ///
-    /// let response = HandlerResponse::stream(my_stream)
-    ///     .with_header(
-    ///         HeaderName::from_static("content-type"),
-    ///         HeaderValue::from_static("application/octet-stream")
-    ///     );
-    /// ```
-    pub fn with_header(mut self, name: HeaderName, value: HeaderValue) -> Self {
-        if let HandlerResponse::Stream { headers, .. } = &mut self {
-            headers.insert(name, value);
-        }
-        self
-    }
-}
+use axum::{
+    BoxError,
+    body::Body,
+    http::{HeaderMap, HeaderName, HeaderValue, StatusCode},
+    response::Response as AxumResponse,
+};
+use bytes::Bytes;
+use futures::{Stream, StreamExt};
+use std::pin::Pin;
+/// Unified response type that can represent either a ready response or a streaming body.
+///
+/// This enum allows handlers to return either:
+/// - A complete response that's ready to send (`Response` variant)
+/// - A streaming response with potentially unbounded data (`Stream` variant)
+///
+/// # Variants
+///
+/// * `Response` - A complete Axum response ready to send to the client. Use this for
+///   responses where you have all the data ready (files, JSON bodies, HTML, etc.)
+///
+/// * `Stream` - A streaming response that produces data chunks over time. Use this for:
+///   - Large files (avoid loading entire file in memory)
+///   - Server-Sent Events (SSE)
+///   - Long-polling responses
+///   - Real-time data feeds
+///   - Any unbounded or very large responses
+///
+/// # Examples
+///
+/// ```ignore
+/// // Regular response
+/// let response = AxumResponse::builder()
+///     .status(StatusCode::OK)
+///     .body(Body::from("Hello"))
+///     .unwrap();
+/// let handler_response = HandlerResponse::from(response);
+///
+/// // Streaming response
+/// let stream = futures::stream::iter(vec![
+///     Ok::<_, Box<dyn std::error::Error>>(Bytes::from("chunk1")),
+///     Ok(Bytes::from("chunk2")),
+/// ]);
+/// let response = HandlerResponse::stream(stream)
+///     .with_status(StatusCode::OK);
+/// ```
+pub enum HandlerResponse {
+    /// A complete response ready to send
+    Response(AxumResponse<Body>),
+    /// A streaming response with custom status and headers
+    Stream {
+        /// The byte stream that will be sent to the client
+        stream: Pin<Box<dyn Stream<Item = Result<Bytes, BoxError>> + Send + 'static>>,
+        /// HTTP status code for the response
+        status: StatusCode,
+        /// Response headers to send
+        headers: HeaderMap,
+    },
+}
+impl From<AxumResponse<Body>> for HandlerResponse {
+    fn from(response: AxumResponse<Body>) -> Self {
+        HandlerResponse::Response(response)
+    }
+}
+impl HandlerResponse {
+    /// Convert the handler response into an Axum response.
+    ///
+    /// Consumes the `HandlerResponse` and produces an `AxumResponse<Body>` ready
+    /// to be sent to the client. For streaming responses, wraps the stream in an
+    /// Axum Body.
+    ///
+    /// # Returns
+    /// An `AxumResponse<Body>` ready to be returned from an Axum handler
+    pub fn into_response(self) -> AxumResponse<Body> {
+        match self {
+            HandlerResponse::Response(response) => response,
+            HandlerResponse::Stream {
+                stream,
+                status,
+                mut headers,
+            } => {
+                let body = Body::from_stream(stream);
+                let mut response = AxumResponse::new(body);
+                *response.status_mut() = status;
+                response.headers_mut().extend(headers.drain());
+                response
+            }
+        }
+    }
+    /// Create a streaming response from any async stream of byte chunks.
+    ///
+    /// Wraps an async stream of byte chunks into a `HandlerResponse::Stream`.
+    /// This is useful for large files, real-time data, or any unbounded response.
+    ///
+    /// # Type Parameters
+    /// * `S` - The stream type implementing `Stream<Item = Result<Bytes, E>>`
+    /// * `E` - The error type that can be converted to `BoxError`
+    ///
+    /// # Arguments
+    /// * `stream` - An async stream that yields byte chunks or errors
+    ///
+    /// # Returns
+    /// A `HandlerResponse` with 200 OK status and empty headers (customize with
+    /// `with_status()` and `with_header()`)
+    ///
+    /// # Example
+    ///
+    /// ```ignore
+    /// use futures::stream;
+    /// use spikard_http::HandlerResponse;
+    /// use bytes::Bytes;
+    ///
+    /// let stream = stream::iter(vec![
+    ///     Ok::<_, Box<dyn std::error::Error>>(Bytes::from("Hello ")),
+    ///     Ok(Bytes::from("World")),
+    /// ]);
+    /// let response = HandlerResponse::stream(stream)
+    ///     .with_status(StatusCode::OK);
+    /// ```
+    pub fn stream<S, E>(stream: S) -> Self
+    where
+        S: Stream<Item = Result<Bytes, E>> + Send + 'static,
+        E: Into<BoxError>,
+    {
+        let mapped = stream.map(|chunk| chunk.map_err(Into::into));
+        HandlerResponse::Stream {
+            stream: Box::pin(mapped),
+            status: StatusCode::OK,
+            headers: HeaderMap::new(),
+        }
+    }
+    /// Override the HTTP status code for the streaming response.
+    ///
+    /// Sets the HTTP status code to be used in the response. This only affects
+    /// `Stream` variants; regular responses already have their status set.
+    ///
+    /// # Arguments
+    /// * `status` - The HTTP status code to use (e.g., `StatusCode::OK`)
+    ///
+    /// # Returns
+    /// Self for method chaining
+    ///
+    /// # Example
+    ///
+    /// ```ignore
+    /// let response = HandlerResponse::stream(my_stream)
+    ///     .with_status(StatusCode::PARTIAL_CONTENT);
+    /// ```
+    pub fn with_status(mut self, status: StatusCode) -> Self {
+        if let HandlerResponse::Stream { status: s, .. } = &mut self {
+            *s = status;
+        }
+        self
+    }
+    /// Insert or replace a header on the streaming response.
+    ///
+    /// Adds an HTTP header to the response. This only affects `Stream` variants;
+    /// regular responses already have their headers set. If a header with the same
+    /// name already exists, it will be replaced.
+    ///
+    /// # Arguments
+    /// * `name` - The header name (e.g., `HeaderName::from_static("content-type")`)
+    /// * `value` - The header value
+    ///
+    /// # Returns
+    /// Self for method chaining
+    ///
+    /// # Example
+    ///
+    /// ```ignore
+    /// use axum::http::{HeaderName, HeaderValue};
+    ///
+    /// let response = HandlerResponse::stream(my_stream)
+    ///     .with_header(
+    ///         HeaderName::from_static("content-type"),
+    ///         HeaderValue::from_static("application/octet-stream")
+    ///     );
+    /// ```
+    pub fn with_header(mut self, name: HeaderName, value: HeaderValue) -> Self {
+        if let HandlerResponse::Stream { headers, .. } = &mut self {
+            headers.insert(name, value);
+        }
+        self
+    }
+}