Clarity Err usage in IntoResponseHeaders

tokio-rs · Jan 25, 2022 · 208720b · 208720b
1 parent 4f6e86f
commit 208720b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/axum-core/src/response/mod.rs b/axum-core/src/response/mod.rs
@@ -156,6 +156,8 @@ pub trait IntoResponseHeaders {
     type IntoIter: IntoIterator<Item = Result<(Option<HeaderName>, HeaderValue), Response>>;
 
     /// Attempt to turn `self` into a list of headers.
+    ///
+    /// In practice, only the implementation for `axum::response::Headers` ever returns `Err(_)`.
     #[doc(hidden)]
     fn into_headers(self) -> Self::IntoIter;
 }