1
0
mirror of https://github.com/actix/actix-website synced 2024-12-12 07:53:10 +01:00
actix-website/static/api/actix-web/stable/actix_web/fs/index.html

65 lines
7.3 KiB
HTML
Raw Normal View History

2018-10-10 17:38:33 +02:00
<!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 `fs` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, fs"><title>actix_web::fs - 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 mod"><!--[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">&#9776;</div><p class='location'>Module fs</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'fs', ty: 'mod', 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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/actix_web/fs.rs.html#1-1786' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>fs</a></span></h1><div class='docblock'><p>Static files support</p>
2018-07-21 13:09:47 +02:00
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.ChunkedReadFile.html"
title='struct actix_web::fs::ChunkedReadFile'>ChunkedReadFile</a></td>
<td class='docblock-short'>
<p>A helper created from a <code>std::fs::File</code> which reads the file
chunk-by-chunk on a <code>CpuPool</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.DefaultConfig.html"
title='struct actix_web::fs::DefaultConfig'>DefaultConfig</a></td>
<td class='docblock-short'>
<p>Default content disposition as described in
<a href="trait.StaticFileConfig.html">StaticFileConfig</a></p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Directory.html"
title='struct actix_web::fs::Directory'>Directory</a></td>
<td class='docblock-short'>
<p>A directory; responds with the generated directory listing.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.NamedFile.html"
title='struct actix_web::fs::NamedFile'>NamedFile</a></td>
<td class='docblock-short'>
<p>A file with an associated name.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.StaticFiles.html"
title='struct actix_web::fs::StaticFiles'>StaticFiles</a></td>
<td class='docblock-short'>
<p>Static files handling</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.StaticFileConfig.html"
title='trait actix_web::fs::StaticFileConfig'>StaticFileConfig</a></td>
<td class='docblock-short'>
<p>Describes <code>StaticFiles</code> configiration</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.file_extension_to_mime.html"
title='fn actix_web::fs::file_extension_to_mime'>file_extension_to_mime</a></td>
<td class='docblock-short'>
<p>Return the MIME type associated with a filename extension (case-insensitive).
If <code>ext</code> is empty or no associated type for the extension was found, returns
the type <code>application/octet-stream</code>.</p>
</td>
</tr></table></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>&#9166;</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>