<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `StaticFiles` struct in crate `actix_web`."><metaname="keywords"content="rust, rustlang, rust-lang, StaticFiles"><title>actix_web::fs::StaticFiles - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><pclass='location'>Struct StaticFiles</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.new">new</a><ahref="#method.with_pool">with_pool</a><ahref="#method.with_config">with_config</a><ahref="#method.with_config_pool">with_config_pool</a><ahref="#method.show_files_listing">show_files_listing</a><ahref="#method.files_listing_renderer">files_listing_renderer</a><ahref="#method.index_file">index_file</a><ahref="#method.default_handler">default_handler</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Handler%3CS%3E">Handler<S></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-From">From</a><ahref="#impl-Into">Into</a><ahref="#impl-TryFrom">TryFrom</a><ahref="#impl-Borrow">Borrow</a><ahref="#impl-BorrowMut">BorrowMut</a><ahref="#impl-TryInto">TryInto</a><ahref="#impl-Any">Any</a><ahref="#impl-Erased">Erased</a></div></div><pclass='location'><ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>fs</a></p><script>window.sidebarCurrent={name:'StaticFiles',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><inputclass="search-input"name="search"autocomplete="off"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../src/actix_web/fs.rs.html#634-644'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>fs</a>::<wbr><aclass="struct"href=''>StaticFiles</a></span></h1><divclass="docblock type-decl hidden-by-usual-hider"><preclass='rust struct'>pub struct StaticFiles<S, C = <aclass="struct"href="../../actix_web/fs/struct.DefaultConfig.html"title="struct actix_web::fs::DefaultConfig">DefaultConfig</a>> { /* fields omitted */ }</pre></div><divclass='docblock'><p>Static files handling</p>
</div><h4id='method.default_handler'class="method"><spanid='default_handler.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.default_handler'class='fnname'>default_handler</a><H: <aclass="trait"href="../../actix_web/dev/trait.Handler.html"title="trait actix_web::dev::Handler">Handler</a><S>>(self, handler: H) -><aclass="struct"href="../../actix_web/fs/struct.StaticFiles.html"title="struct actix_web::fs::StaticFiles">StaticFiles</a><S, C></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/fs.rs.html#733-736'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Sets default handler which is used when no matched file could be found.</p>
</div></div></div><h2id='synthetic-implementations'class='small-section-header'>Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a></h2><divid='synthetic-implementations-list'><h3id='impl-Send'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<S, C = <aclass="struct"href="../../actix_web/fs/struct.DefaultConfig.html"title="struct actix_web::fs::DefaultConfig">DefaultConfig</a>> !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../../actix_web/fs/struct.StaticFiles.html"title="struct actix_web::fs::StaticFiles">StaticFiles</a><S, C></code><ahref='#impl-Send'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<S, C = <aclass="struct"href="../../actix_web/fs/struct.DefaultConfig.html"title="struct actix_web::fs::DefaultConfig">DefaultConfig</a>> !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../../actix_web/fs/struct.StaticFiles.html"title="struct actix_web::fs::StaticFiles">StaticFiles</a><S, C></code><ahref='#impl-Sync'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div><h2id='blanket-implementations'class='small-section-header'>Blanket Implementations<ahref='#blanket-implementations'class='anchor'></a></h2><divid='blanket-implementations-list'><h3id='impl-From'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a> for T</code><ahref='#impl-From'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#462-464'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.from'class="method"><spanid='from.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from'class='fnname'>from</a>(t: T) -> T</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#463'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Performs the conversion.</p>
</div></div><h3id='impl-Into'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></code><ahref='#impl-Into'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#453-458'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.into'class="method"><spanid='into.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into'class='fnname'>into</a>(self) -> U</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#455-457'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryFrom'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><U>, </span></code><ahref='#impl-TryFrom'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#481-487'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><spanid='Error.t'class='invisible'><code>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a></code></span></h4>
<divclass='stability'><divclass='stab unstable'><spanclass=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method"><spanid='try_from.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#484-486'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='stability'><divclass='stab unstable'><spanclass=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><divclass='docblock'><p>Performs the conversion.</p>
</div></div><h3id='impl-Borrow'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219-221'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.borrow'class="method"><spanid='borrow.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-BorrowMut'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#224-226'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method"><spanid='borrow_mut.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#225'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-TryInto'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#469-476'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><spanid='Error.t-1'class='invisible'><code>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></span></h4>
<divclass='stability'><divclass='stab unstable'><spanclass=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method"><spanid='try_into.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#473-475'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='stability'><divclass='stab unstable'><spanclass=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><divclass='docblock'><p>Performs the conversion.</p>
</div></div><h3id='impl-Any'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#114-116'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.get_type_id'class="method"><spanid='get_type_id.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id'class='fnname'>get_type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#115'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='stability'><divclass='stab unstable'><details><summary><spanclass=microscope>🔬</span> This is a nightly-only experimental API. (<code>get_type_id</code>)</summary><p>this method will likely be replaced by an associated static</p>
</details></div></div><divclass='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id">Read more</a></p>
</div></div><h3id='impl-Erased'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<T> Erased for T</code><ahref='#impl-Erased'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><divclass="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath="../../";window.currentCrate="actix_web";</script><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
