26 lines
5.4 KiB
HTML
26 lines
5.4 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 `resource` fn in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, resource"><title>actix_web::web::resource - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>web</a></p><script>window.sidebarCurrent = {name: 'resource', ty: 'fn', 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#54-56' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>web</a>::<wbr><a class="fn" href=''>resource</a></span></h1><pre class='rust fn'>pub fn resource(path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../actix_web/struct.Resource.html" title="struct actix_web::Resource">Resource</a></pre><div class='docblock'><p>Create resource for a specific path.</p>
|
||
<p>Resources may have variable path segments. For example, a
|
||
resource with the path <code>/a/{name}/c</code> would match all incoming
|
||
requests with paths such as <code>/a/b/c</code>, <code>/a/1/c</code>, or <code>/a/etc/c</code>.</p>
|
||
<p>A variable segment is specified in the form <code>{identifier}</code>,
|
||
where the identifier can be used later in a request handler to
|
||
access the matched value for that segment. This is done by
|
||
looking up the identifier in the <code>Params</code> object returned by
|
||
<code>HttpRequest.match_info()</code> method.</p>
|
||
<p>By default, each segment matches the regular expression <code>[^{}/]+</code>.</p>
|
||
<p>You can also specify a custom regex in the form <code>{identifier:regex}</code>:</p>
|
||
<p>For instance, to route <code>GET</code>-requests on any route matching
|
||
<code>/users/{userid}/{friend}</code> and store <code>userid</code> and <code>friend</code> in
|
||
the exposed <code>Params</code> object:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/users/{userid}/{friend}"</span>)
|
||
.<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
||
.<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">head</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>()))
|
||
);
|
||
}</pre></div>
|
||
</div></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> |