mirror of
https://github.com/actix/actix-website
synced 2024-11-25 01:02:58 +01:00
50 lines
10 KiB
HTML
50 lines
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `StaticFileConfig` trait in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, StaticFileConfig"><title>actix_web::fs::StaticFileConfig - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Trait StaticFileConfig</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.content_disposition_map">content_disposition_map</a><a href="#method.is_use_etag">is_use_etag</a><a href="#method.is_use_last_modifier">is_use_last_modifier</a><a href="#method.is_method_allowed">is_method_allowed</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>fs</a></p><script>window.sidebarCurrent = {name: 'StaticFileConfig', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>fs</a>::<wbr><a class="trait" href=''>StaticFileConfig</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/fs.rs.html#59-91' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait StaticFileConfig: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> {
|
||
fn <a href='#method.content_disposition_map' class='fnname'>content_disposition_map</a>(typ: <a class="struct" href="https://docs.rs/mime/0.3.8/mime/struct.Name.html" title="struct mime::Name">Name</a>) -> <a class="enum" href="../../actix_web/http/header/enum.DispositionType.html" title="enum actix_web::http::header::DispositionType">DispositionType</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.is_use_etag' class='fnname'>is_use_etag</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.is_use_last_modifier' class='fnname'>is_use_last_modifier</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.is_method_allowed' class='fnname'>is_method_allowed</a>(_method: &<a class="struct" href="../../actix_web/http/struct.Method.html" title="struct actix_web::http::Method">Method</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
}</pre></div><div class='docblock'><p>Describes <code>StaticFiles</code> configiration</p>
|
||
<p>To configure actix's static resources you need
|
||
to define own configiration type and implement any method
|
||
you wish to customize.
|
||
As trait implements reasonable defaults for Actix.</p>
|
||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mime</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix_web</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">http</span>::<span class="ident">header</span>::<span class="ident">DispositionType</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">fs</span>::{<span class="ident">StaticFileConfig</span>, <span class="ident">NamedFile</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">MyConfig</span>;
|
||
|
||
<span class="kw">impl</span> <span class="ident">StaticFileConfig</span> <span class="kw">for</span> <span class="ident">MyConfig</span> {
|
||
<span class="kw">fn</span> <span class="ident">content_disposition_map</span>(<span class="ident">typ</span>: <span class="ident">mime</span>::<span class="ident">Name</span>) <span class="op">-></span> <span class="ident">DispositionType</span> {
|
||
<span class="ident">DispositionType</span>::<span class="ident">Attachment</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">NamedFile</span>::<span class="ident">open_with_config</span>(<span class="string">"foo.txt"</span>, <span class="ident">MyConfig</span>);</pre>
|
||
</div>
|
||
<h2 id='provided-methods' class='small-section-header'>
|
||
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.content_disposition_map' class='method'><span id='content_disposition_map.v' class='invisible'><code>fn <a href='#method.content_disposition_map' class='fnname'>content_disposition_map</a>(typ: <a class="struct" href="https://docs.rs/mime/0.3.8/mime/struct.Name.html" title="struct mime::Name">Name</a>) -> <a class="enum" href="../../actix_web/http/header/enum.DispositionType.html" title="enum actix_web::http::header::DispositionType">DispositionType</a></code></span></h3><div class='docblock'><p>Describes mapping for mime type to content disposition header</p>
|
||
<p>By default <code>IMAGE</code>, <code>TEXT</code> and <code>VIDEO</code> are mapped to Inline.
|
||
Others are mapped to Attachment</p>
|
||
</div><h3 id='method.is_use_etag' class='method'><span id='is_use_etag.v' class='invisible'><code>fn <a href='#method.is_use_etag' class='fnname'>is_use_etag</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Describes whether Actix should attempt to calculate <code>ETag</code></p>
|
||
<p>Defaults to <code>true</code></p>
|
||
</div><h3 id='method.is_use_last_modifier' class='method'><span id='is_use_last_modifier.v' class='invisible'><code>fn <a href='#method.is_use_last_modifier' class='fnname'>is_use_last_modifier</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Describes whether Actix should use last modified date of file.</p>
|
||
<p>Defaults to <code>true</code></p>
|
||
</div><h3 id='method.is_method_allowed' class='method'><span id='is_method_allowed.v' class='invisible'><code>fn <a href='#method.is_method_allowed' class='fnname'>is_method_allowed</a>(_method: &<a class="struct" href="../../actix_web/http/struct.Method.html" title="struct actix_web::http::Method">Method</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Describes allowed methods to access static resources.</p>
|
||
<p>By default all methods are allowed</p>
|
||
</div></div>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl StaticFileConfig for <a class="struct" href="../../actix_web/fs/struct.DefaultConfig.html" title="struct actix_web::fs::DefaultConfig">DefaultConfig</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/fs.rs.html#97' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../implementors/actix_web/fs/trait.StaticFileConfig.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="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><div class="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><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |