mirror of
https://github.com/fafhrd91/actix-web
synced 2025-01-19 14:14:41 +01:00
24 lines
4.8 KiB
HTML
24 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 scope for common path prefix."><title>scope 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="#">scope</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#91-93">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn scope(path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../struct.Scope.html" title="struct actix_web::Scope">Scope</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates scope for common path prefix.</p>
|
||
<p>Scopes collect multiple paths under a common path prefix. The scope’s path can contain dynamic
|
||
path segments.</p>
|
||
<h2 id="avoid-trailing-slashes"><a class="doc-anchor" href="#avoid-trailing-slashes">§</a>Avoid Trailing Slashes</h2>
|
||
<p>Avoid using trailing slashes in the scope prefix (e.g., <code>web::scope("/scope/")</code>). It will almost
|
||
certainly not have the expected behavior. See the <a href="../dev/struct.ResourceDef.html#prefix-resources" title="struct actix_web::dev::ResourceDef">documentation on resource definitions</a>
|
||
to understand why this is the case and how to correctly construct scope/prefix definitions.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<p>In this example, three routes are set up (and will handle any method):</p>
|
||
<ul>
|
||
<li><code>/{project_id}/path1</code></li>
|
||
<li><code>/{project_id}/path2</code></li>
|
||
<li><code>/{project_id}/path3</code></li>
|
||
</ul>
|
||
<h2 id="examples-1"><a class="doc-anchor" href="#examples-1">§</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::scope(<span class="string">"/{project_id}"</span>)
|
||
.service(web::resource(<span class="string">"/path1"</span>).to(|| HttpResponse::Ok()))
|
||
.service(web::resource(<span class="string">"/path2"</span>).to(|| HttpResponse::Ok()))
|
||
.service(web::resource(<span class="string">"/path3"</span>).to(|| HttpResponse::MethodNotAllowed()))
|
||
);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |