38 lines
9.6 KiB
HTML
38 lines
9.6 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 `web` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, web"><title>actix_web::web - 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><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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><a href='../../actix_web/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module web</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</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: 'web', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/web.rs.html#1-309' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>web</a></span></h1><div class='docblock'><p>Essentials helper functions and types for application registration.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Bytes.html" title='actix_web::web::Bytes struct'>Bytes</a></td><td class='docblock-short'><p>A reference counted contiguous slice of memory.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.BytesMut.html" title='actix_web::web::BytesMut struct'>BytesMut</a></td><td class='docblock-short'><p>A unique reference to a contiguous slice of memory.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Data.html" title='actix_web::web::Data struct'>Data</a></td><td class='docblock-short'><p>Application data.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Form.html" title='actix_web::web::Form struct'>Form</a></td><td class='docblock-short'><p>Form data helper (<code>application/x-www-form-urlencoded</code>)</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FormConfig.html" title='actix_web::web::FormConfig struct'>FormConfig</a></td><td class='docblock-short'><p>Form extractor configuration</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HttpRequest.html" title='actix_web::web::HttpRequest struct'>HttpRequest</a></td><td class='docblock-short'><p>An HTTP Request</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HttpResponse.html" title='actix_web::web::HttpResponse struct'>HttpResponse</a></td><td class='docblock-short'><p>An HTTP Response</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Json.html" title='actix_web::web::Json struct'>Json</a></td><td class='docblock-short'><p>Json helper</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.JsonConfig.html" title='actix_web::web::JsonConfig struct'>JsonConfig</a></td><td class='docblock-short'><p>Json extractor configuration</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Path.html" title='actix_web::web::Path struct'>Path</a></td><td class='docblock-short'><p>Extract typed information from the request's path.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PathConfig.html" title='actix_web::web::PathConfig struct'>PathConfig</a></td><td class='docblock-short'><p>Path extractor configuration</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Payload.html" title='actix_web::web::Payload struct'>Payload</a></td><td class='docblock-short'><p>Payload extractor returns request 's payload stream.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PayloadConfig.html" title='actix_web::web::PayloadConfig struct'>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.Query.html" title='actix_web::web::Query struct'>Query</a></td><td class='docblock-short'><p>Extract typed information from the request's query.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.QueryConfig.html" title='actix_web::web::QueryConfig struct'>QueryConfig</a></td><td class='docblock-short'><p>Query extractor configuration</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ServiceConfig.html" title='actix_web::web::ServiceConfig struct'>ServiceConfig</a></td><td class='docblock-short'><p>Service config is used for external configuration.
|
||
Part of application configuration could be offloaded
|
||
to set of external methods. This could help with
|
||
modularization of big application configuration.</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.block.html" title='actix_web::web::block fn'>block</a></td><td class='docblock-short'><p>Execute blocking function on a thread pool, returns future that resolves
|
||
to result of the function execution.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.delete.html" title='actix_web::web::delete fn'>delete</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>DELETE</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get.html" title='actix_web::web::get fn'>get</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>GET</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.head.html" title='actix_web::web::head fn'>head</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>HEAD</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.method.html" title='actix_web::web::method fn'>method</a></td><td class='docblock-short'><p>Create <em>route</em> and add method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.patch.html" title='actix_web::web::patch fn'>patch</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>PATCH</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.post.html" title='actix_web::web::post fn'>post</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>POST</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.put.html" title='actix_web::web::put fn'>put</a></td><td class='docblock-short'><p>Create <em>route</em> with <code>PUT</code> method guard.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resource.html" title='actix_web::web::resource fn'>resource</a></td><td class='docblock-short'><p>Create resource for a specific path.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.route.html" title='actix_web::web::route fn'>route</a></td><td class='docblock-short'><p>Create <em>route</em> without configuration.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.scope.html" title='actix_web::web::scope fn'>scope</a></td><td class='docblock-short'><p>Configure scope for common root path.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.service.html" title='actix_web::web::service fn'>service</a></td><td class='docblock-short'><p>Create raw service for a specific path.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.to.html" title='actix_web::web::to fn'>to</a></td><td class='docblock-short'><p>Create a new route and add handler.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.to_async.html" title='actix_web::web::to_async fn'>to_async</a></td><td class='docblock-short'><p>Create a new route and add async handler.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><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> |