clarify docs for BodyEncoding::encoding() (actix#2258)

lb-cake · Jun 10, 2021 · 812269d · 812269d
1 parent e46cda5
commit 812269d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/actix-files/src/named.rs b/actix-files/src/named.rs
@@ -235,6 +235,8 @@ impl NamedFile {
     }
 
     /// Set content encoding for serving this file
+    ///
+    /// Must be used with [`actix_web::middleware::Compress`] to take effect.
     #[inline]
     pub fn set_content_encoding(mut self, enc: ContentEncoding) -> Self {
         self.encoding = Some(enc);

diff --git a/src/lib.rs b/src/lib.rs
@@ -169,6 +169,8 @@ pub mod dev {
         fn get_encoding(&self) -> Option<ContentEncoding>;
 
         /// Set content encoding
+        ///
+        /// Must be used with [`crate::middleware::Compress`] to take effect.
         fn encoding(&mut self, encoding: ContentEncoding) -> &mut Self;
     }