mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-30 10:42:55 +01:00
19 lines
4.8 KiB
HTML
19 lines
4.8 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="Creates a new resource for a specific path."><title>resource in actix_web::web - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_web" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../actix_web/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../actix_web/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_web/index.html">actix_web</a><span class="version">4.6.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_web::web</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">actix_web</a>::<wbr><a href="index.html">web</a>::<wbr><a class="fn" href="#">resource</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/actix_web/web.rs.html#58-60">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn resource<T: <a class="trait" href="../../actix_router/pattern/trait.IntoPatterns.html" title="trait actix_router::pattern::IntoPatterns">IntoPatterns</a>>(path: T) -> <a class="struct" href="../struct.Resource.html" title="struct actix_web::Resource">Resource</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new resource for a specific path.</p>
|
||
|
|
<p>Resources may have dynamic 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 dynamic 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>Path</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>Path</code> object:</p>
|
||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{web, App, HttpResponse};
|
||
|
|
|
||
|
|
<span class="kw">let </span>app = App::new().service(
|
||
|
|
web::resource(<span class="string">"/users/{userid}/{friend}"</span>)
|
||
|
|
.route(web::get().to(|| HttpResponse::Ok()))
|
||
|
|
.route(web::head().to(|| HttpResponse::MethodNotAllowed()))
|
||
|
|
);</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|