clean up files service docs and rename method

follow on from #2046

actix-files/src/files.rs

@@ -158,7 +158,6 @@ impl Files {
     /// Specifies whether to use ETag or not.
     ///
     /// Default is true.
-    #[inline]
     pub fn use_etag(mut self, value: bool) -> Self {
         self.file_flags.set(named::Flags::ETAG, value);
         self
@@ -167,7 +166,6 @@ impl Files {
     /// Specifies whether to use Last-Modified or not.
     ///
     /// Default is true.
-    #[inline]
     pub fn use_last_modified(mut self, value: bool) -> Self {
         self.file_flags.set(named::Flags::LAST_MD, value);
         self
@@ -176,46 +174,55 @@ impl Files {
     /// Specifies whether text responses should signal a UTF-8 encoding.
     ///
     /// Default is false (but will default to true in a future version).
-    #[inline]
     pub fn prefer_utf8(mut self, value: bool) -> Self {
         self.file_flags.set(named::Flags::PREFER_UTF8, value);
         self
     }
 
-    /// Specifies custom guards to use for directory listings and files.
+    /// Adds a routing guard.
     ///
-    /// Default behaviour allows GET and HEAD.
+    /// Use this to allow multiple chained file services that respond to strictly different
-    #[inline]
+    /// properties of a request. Due to the way routing works, if a guard check returns true and the
-    pub fn use_guards<G: Guard + 'static>(mut self, guards: G) -> Self {
+    /// request starts being handled by the file service, it will not be able to back-out and try
-        self.use_guards = Some(Rc::new(guards));
+    /// the next service, you will simply get a 404 (or 405) error response.
-        self
-    }
-
-    /// Add match guard to use on directory listings and files.
     ///
-    /// ```rust
+    /// To allow `POST` requests to retrieve files, see [`Files::use_guards`].
-    /// use actix_web::{guard, App};
+    ///
+    /// # Examples
+    /// ```
+    /// use actix_web::{guard::Header, App};
     /// use actix_files::Files;
     ///
-    ///
+    /// App::new().service(
-    /// fn main() {
+    ///     Files::new("/","/my/site/files")
-    ///     let app = App::new()
+    ///         .guard(Header("Host", "example.com"))
-    ///         .service(
+    /// );
-    ///             Files::new("/","/my/site/files")
-    ///                 .guard(guard::Header("Host", "example.com"))
-    ///         );
-    /// }
     /// ```
-    #[inline]
     pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
         self.guards.push(Box::new(Rc::new(guard)));
         self
     }
 
+    /// Specifies guard to check before fetching directory listings or files.
+    ///
+    /// Note that this guard has no effect on routing; it's main use is to guard on the request's
+    /// method just before serving the file, only allowing `GET` and `HEAD` requests by default.
+    /// See [`Files::guard`] for routing guards.
+    pub fn method_guard<G: Guard + 'static>(mut self, guard: G) -> Self {
+        self.use_guards = Some(Rc::new(guard));
+        self
+    }
+
+    #[doc(hidden)]
+    #[deprecated(since = "0.6.0", note = "Renamed to `method_guard`.")]
+    /// See [`Files::method_guard`].
+    pub fn use_guards<G: Guard + 'static>(self, guard: G) -> Self {
+        self.method_guard(guard)
+    }
+
     /// Disable `Content-Disposition` header.
     ///
     /// By default Content-Disposition` header is enabled.
-    #[inline]
     pub fn disable_content_disposition(mut self) -> Self {
         self.file_flags.remove(named::Flags::CONTENT_DISPOSITION);
         self
@@ -223,8 +230,9 @@ impl Files {
 
     /// Sets default handler which is used when no matched file could be found.
     ///
-    /// For example, you could set a fall back static file handler:
+    /// # Examples
-    /// ```rust
+    /// Setting a fallback static file handler:
+    /// ```
     /// use actix_files::{Files, NamedFile};
     ///
     /// # fn run() -> Result<(), actix_web::Error> {
@@ -253,7 +261,6 @@ impl Files {
     }
 
     /// Enables serving hidden files and directories, allowing a leading dots in url fragments.
-    #[inline]
     pub fn use_hidden_files(mut self) -> Self {
         self.hidden_files = true;
         self

actix-files/src/lib.rs

@@ -532,7 +532,7 @@ mod tests {
     #[actix_rt::test]
     async fn test_files_guards() {
         let srv = test::init_service(
-            App::new().service(Files::new("/", ".").use_guards(guard::Post())),
+            App::new().service(Files::new("/", ".").method_guard(guard::Post())),
         )
         .await;