Add FileStream response to axum-extra (#3047)

tokio-rs · Dec 4, 2024 · 7c871e9 · 7c871e9
1 parent 99c07e4
commit 7c871e9
Show file tree

Hide file tree

Showing 5 changed files with 599 additions and 0 deletions.
diff --git a/axum-extra/CHANGELOG.md b/axum-extra/CHANGELOG.md
@@ -13,12 +13,14 @@ and this project adheres to [Semantic Versioning].
 - **added:** Add `json!` for easy construction of JSON responses ([#2962])
 - **added:** Add `InternalServerError` response for logging an internal error
   and returning HTTP 500 in a convenient way. ([#3010])
+- **added:** Add `FileStream` for easy construction of file stream responses ([#3047])
 
 [#2242]: https://github.com/tokio-rs/axum/pull/2242
 [#3058]: https://github.com/tokio-rs/axum/pull/3058
 [#2961]: https://github.com/tokio-rs/axum/pull/2961
 [#2962]: https://github.com/tokio-rs/axum/pull/2962
 [#3010]: https://github.com/tokio-rs/axum/pull/3010
+[#3047]: https://github.com/tokio-rs/axum/pull/3047
 
 # 0.10.0
 

diff --git a/axum-extra/Cargo.toml b/axum-extra/Cargo.toml
@@ -15,6 +15,7 @@ version = "0.10.0-alpha.1"
 default = ["tracing"]
 
 async-read-body = ["dep:tokio-util", "tokio-util?/io", "dep:tokio"]
+file-stream = ["dep:tokio-util", "tokio-util?/io", "dep:tokio", "tokio?/fs", "tokio?/io-util"]
 attachment = ["dep:tracing"]
 error-response = ["dep:tracing", "tracing/std"]
 cookie = ["dep:cookie"]
@@ -56,6 +57,7 @@ tower-layer = "0.3"
 tower-service = "0.3"
 
 # optional dependencies
+async-stream = { version = "0.3", optional = true }
 axum-macros = { path = "../axum-macros", version = "0.5.0-alpha.1", optional = true }
 cookie = { package = "cookie", version = "0.18.0", features = ["percent-encode"], optional = true }
 fastrand = { version = "2.1.0", optional = true }
@@ -107,6 +109,7 @@ allowed = [
     "prost",
     "serde",
     "tokio",
+    "tokio_util",
     "tower_layer",
     "tower_service",
 ]
diff --git a/axum-extra/src/lib.rs b/axum-extra/src/lib.rs
@@ -26,6 +26,7 @@
 //! `tracing` | Log rejections from built-in extractors | Yes
 //! `typed-routing` | Enables the [`TypedPath`](crate::routing::TypedPath) routing utilities | No
 //! `typed-header` | Enables the [`TypedHeader`] extractor and response | No
+//! `FileStream` | Enables the [`FileStream`](crate::response::FileStream) response | No
 //!
 //! [`axum`]: https://crates.io/crates/axum