From 7416630d657757d4cb147e9a748d94d1de35a364 Mon Sep 17 00:00:00 2001 From: Tglman Date: Fri, 5 Mar 2021 14:44:14 +0000 Subject: [PATCH] add documentation on Files guard --- actix-files/src/files.rs | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/actix-files/src/files.rs b/actix-files/src/files.rs index bb0ec12af..f7d2e1ee1 100644 --- a/actix-files/src/files.rs +++ b/actix-files/src/files.rs @@ -172,8 +172,21 @@ impl Files { self } - /// Specifies custom guards to use for directory listings and files. + /// Add match guard to use on directory listings and files. /// + /// ```rust + /// use actix_web::{guard, App}; + /// use actix_files::Files; + /// + /// + /// fn main() { + /// let app = App::new() + /// .service( + /// Files::new("/","/my/site/files") + /// .guard(guard::Header("Host", "example.com")) + /// ); + /// } + /// ``` #[inline] pub fn guard(mut self, guard: G) -> Self { self.guards.push(Box::new(guard));