Add an encapsulated file stream in axum-extra to make it more conveni…

axum-extra/CHANGELOG.md

@@ -10,10 +10,12 @@ and this project adheres to [Semantic Versioning].
 - **fixed:** `Host` extractor includes port number when parsing authority ([#2242])
 - **added:** Add `RouterExt::typed_connect` ([#2961])
 - **added:** Add `json!` for easy construction of JSON responses ([#2962])
+- **added:** Add `FileStream` for easy construction of file stream responses ([#3047])
 
 [#2242]: https://github.com/tokio-rs/axum/pull/2242
 [#2961]: https://github.com/tokio-rs/axum/pull/2961
 [#2962]: https://github.com/tokio-rs/axum/pull/2962
+[#3047]: https://github.com/tokio-rs/axum/pull/3047
 
 # 0.10.0
 

axum-extra/Cargo.toml

@@ -15,6 +15,7 @@ version = "0.10.0-alpha.1"
 default = ["tracing", "multipart"]
 
 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", "dep:async-stream"]
 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 }
@@ -74,6 +76,7 @@ tracing = { version = "0.1.37", default-features = false, optional = true }
 typed-json = { version = "0.1.1", optional = true }
 
 [dev-dependencies]
+async-stream = "0.3"
 axum = { path = "../axum", features = ["macros"] }
 axum-macros = { path = "../axum-macros", features = ["__private"] }
 hyper = "1.0.0"

axum-extra/src/lib.rs

@@ -25,8 +25,9 @@
 //! `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::file_stream) response | No
 //!
-//! [`axum`]: https://crates.io/crates/axum
+//! [`axum`]: <https://crates.io/crates/axum>
 
 #![warn(
     clippy::all,