mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-30 10:42:55 +01:00
19 lines
4.4 KiB
HTML
19 lines
4.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="Creates route handler with `actix_web::guard::Patch`."><title>patch in actix_web_codegen - 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_codegen" 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 attr"><!--[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_codegen/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_codegen/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_web_codegen/index.html">actix_web_codegen</a><span class="version">4.2.2</span></h2></div><div class="sidebar-elems"></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>Attribute Macro <a href="index.html">actix_web_codegen</a>::<wbr><a class="attr" href="#">patch</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_codegen/lib.rs.html#198">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>#[patch]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates route handler with <code>actix_web::guard::Patch</code>.</p>
|
||
|
|
<h2 id="syntax"><a class="doc-anchor" href="#syntax">§</a>Syntax</h2><div class="example-wrap"><pre class="language-plain"><code>#[patch("path"[, attributes])]
|
||
|
|
</code></pre></div><h2 id="attributes"><a class="doc-anchor" href="#attributes">§</a>Attributes</h2>
|
||
|
|
<ul>
|
||
|
|
<li><code>"path"</code>: Raw literal string with path for which to register handler.</li>
|
||
|
|
<li><code>name = "resource_name"</code>: Specifies resource name for the handler. If not set, the
|
||
|
|
function name of handler is used.</li>
|
||
|
|
<li><code>guard = "function_name"</code>: Registers function as guard using <code>actix_web::guard::fn_guard</code>.</li>
|
||
|
|
<li><code>wrap = "Middleware"</code>: Registers a resource middleware.</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h2>
|
||
|
|
<p>Function name can be specified as any expression that is going to be accessible to the
|
||
|
|
generate code, e.g <code>my_guard</code> or <code>my_module::my_guard</code>.</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="attr">#[patch(<span class="string">"/"</span>)]
|
||
|
|
</span><span class="kw">async fn </span>example() -> HttpResponse {
|
||
|
|
HttpResponse::Ok().finish()
|
||
|
|
}</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|