mirror of
https://github.com/actix/actix-website
synced 2024-11-24 16:52:59 +01:00
188 lines
14 KiB
HTML
188 lines
14 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 `dev` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, dev"><title>actix_web::dev - 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">☰</div><p class='location'>Module dev</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'dev', 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='in-band'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>dev</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/lib.rs.html#227-251' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>The <code>actix-web</code> prelude for library developers</p>
|
|||
|
|
<p>The purpose of this module is to alleviate imports of many common actix
|
|||
|
|
traits by adding a glob import to the top of actix heavy modules:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">dev</span>::<span class="kw-2">*</span>;</pre>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.AsyncResult.html"
|
|||
|
|
title='struct actix_web::dev::AsyncResult'>AsyncResult</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Represents async result</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.ConnectionInfo.html"
|
|||
|
|
title='struct actix_web::dev::ConnectionInfo'>ConnectionInfo</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><code>HttpRequest</code> connection information</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Drain.html"
|
|||
|
|
title='struct actix_web::dev::Drain'>Drain</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Consume a future</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.FormConfig.html"
|
|||
|
|
title='struct actix_web::dev::FormConfig'>FormConfig</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Form extractor configuration</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.HttpResponseBuilder.html"
|
|||
|
|
title='struct actix_web::dev::HttpResponseBuilder'>HttpResponseBuilder</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An HTTP response builder</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.JsonBody.html"
|
|||
|
|
title='struct actix_web::dev::JsonBody'>JsonBody</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Request payload json parser that resolves to a deserialized <code>T</code> value.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.JsonConfig.html"
|
|||
|
|
title='struct actix_web::dev::JsonConfig'>JsonConfig</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Json extractor configuration</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.MessageBody.html"
|
|||
|
|
title='struct actix_web::dev::MessageBody'>MessageBody</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Future that resolves to a complete http message body.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Params.html"
|
|||
|
|
title='struct actix_web::dev::Params'>Params</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Route match information</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Payload.html"
|
|||
|
|
title='struct actix_web::dev::Payload'>Payload</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Buffered stream of bytes chunks</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.PayloadBuffer.html"
|
|||
|
|
title='struct actix_web::dev::PayloadBuffer'>PayloadBuffer</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Payload buffer</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.PayloadConfig.html"
|
|||
|
|
title='struct actix_web::dev::PayloadConfig'>PayloadConfig</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Payload configuration for request's payload.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Resource.html"
|
|||
|
|
title='struct actix_web::dev::Resource'>Resource</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><em>Resource</em> is an entry in route table which corresponds to requested URL.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.ResourceDef.html"
|
|||
|
|
title='struct actix_web::dev::ResourceDef'>ResourceDef</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Resource type describes an entry in resources table</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.ResourceInfo.html"
|
|||
|
|
title='struct actix_web::dev::ResourceInfo'>ResourceInfo</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Information about current resource</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Route.html"
|
|||
|
|
title='struct actix_web::dev::Route'>Route</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Resource route definition</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Router.html"
|
|||
|
|
title='struct actix_web::dev::Router'>Router</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Interface for application router.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.UrlEncoded.html"
|
|||
|
|
title='struct actix_web::dev::UrlEncoded'>UrlEncoded</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Future that resolves to a parsed urlencoded values.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.ResourceType.html"
|
|||
|
|
title='enum actix_web::dev::ResourceType'>ResourceType</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Resource type</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.FromParam.html"
|
|||
|
|
title='trait actix_web::dev::FromParam'>FromParam</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A trait to abstract the idea of creating a new instance of a type from a
|
|||
|
|
path parameter.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.Handler.html"
|
|||
|
|
title='trait actix_web::dev::Handler'>Handler</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Trait defines object that could be registered as route handler</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="type" href="type.BodyStream.html"
|
|||
|
|
title='type actix_web::dev::BodyStream'>BodyStream</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Type represent streaming body</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>⏎</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>
|