actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 07:53:00 +01:00
Code Issues Releases Wiki Activity
f438a616e1
actix-extras/actix_cors/index.html

44 lines
7.9 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
<!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="Cross-Origin Resource Sharing (CORS) controls for Actix Web."><meta name="keywords" content="rust, rustlang, rust-lang, actix_cors"><title>actix_cors - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https:&#x2F;&#x2F;actix.rs&#x2F;favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../actix_cors/index.html'><div class='logo-container rust-logo'><img src='https:&#x2F;&#x2F;actix.rs&#x2F;img&#x2F;logo.png' alt='logo'></div></a><h2 class="location">Crate actix_cors</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.6.0-beta.2</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all actix_cors's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><div id="sidebar-vars" data-name="actix_cors" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">actix_cors</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><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">&#x2212;</span>]</a></span><a class="srclink" href="../src/actix_cors/lib.rs.html#1-60" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cross-Origin Resource Sharing (CORS) controls for Actix Web.</p>
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<p>This middleware can be applied to both applications and resources. Once built, a
Deploying to gh-pages from @ 20ef05c36e9457b1f593831a06df68426db35b00 🚀
2021-06-27 08:05:12 +02:00
<a href="struct.Cors.html" title="Cors"><code>Cors</code></a> builder can be used as an argument for Actix Web’s <code>App::wrap()</code>,
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<code>Scope::wrap()</code>, or <code>Resource::wrap()</code> methods.</p>
<p>This CORS middleware automatically handles <code>OPTIONS</code> preflight requests.</p>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">actix_cors::Cors</span>;
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">get</span>, <span class="ident">http</span>, <span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>, <span class="ident">HttpServer</span>};
<span class="attribute">#[<span class="ident">get</span>(<span class="string">&quot;/index.html&quot;</span>)]</span>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">req</span>: <span class="ident">HttpRequest</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span> {
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
<span class="string">&quot;&lt;p&gt;Hello World!&lt;/p&gt;&quot;</span>
}
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
<span class="attribute">#[<span class="ident">actix_web::main</span>]</span>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() -&gt; <span class="ident">std::io::Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
<span class="ident">HttpServer::new</span>(<span class="op">|</span><span class="op">|</span> {
<span class="kw">let</span> <span class="ident">cors</span> <span class="op">=</span> <span class="ident">Cors::default</span>()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
.<span class="ident">allowed_origin</span>(<span class="string">&quot;https://www.rust-lang.org/&quot;</span>)
.<span class="ident">allowed_origin_fn</span>(<span class="op">|</span><span class="ident">origin</span>, <span class="ident">_req_head</span><span class="op">|</span> {
<span class="ident">origin</span>.<span class="ident">as_bytes</span>().<span class="ident">ends_with</span>(<span class="string">b&quot;.rust-lang.org&quot;</span>)
})
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
.<span class="ident">allowed_methods</span>(<span class="macro">vec!</span>[<span class="string">&quot;GET&quot;</span>, <span class="string">&quot;POST&quot;</span>])
.<span class="ident">allowed_headers</span>(<span class="macro">vec!</span>[<span class="ident">http::header::AUTHORIZATION</span>, <span class="ident">http::header::ACCEPT</span>])
.<span class="ident">allowed_header</span>(<span class="ident">http::header::CONTENT_TYPE</span>)
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
.<span class="ident">max_age</span>(<span class="number">3600</span>);
Deploying to gh-pages from @ 8741cd32cc0da75b2eae031bf00da8bd1d87bbac 🚀
2021-04-09 15:42:26 +02:00
<span class="ident">App::new</span>()
Deploying to gh-pages from @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀
2021-03-22 12:49:07 +01:00
.<span class="ident">wrap</span>(<span class="ident">cors</span>)
.<span class="ident">service</span>(<span class="ident">index</span>)
})
.<span class="ident">bind</span>((<span class="string">&quot;127.0.0.1&quot;</span>, <span class="number">8080</span>))<span class="question-mark">?</span>
.<span class="ident">run</span>()
.<span class="kw">await</span>;
<span class="prelude-val">Ok</span>(())
Deploying to gh-pages from @ c6f579790fbdcd55368ac5547e3e5b0ffec72961 🚀
2021-08-31 00:13:55 +02:00
}</code></pre></div>
Deploying to gh-pages from @ 20ef05c36e9457b1f593831a06df68426db35b00 🚀
2021-06-27 08:05:12 +02:00
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
Deploying to gh-pages from @ 798a5d6d0e48de06e2bd9ac1a48098110aabbdca 🚀
2021-10-11 03:57:28 +02:00
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Cors.html" title="actix_cors::Cors struct">Cors</a></div><div class="item-right docblock-short"><p>Builder for CORS middleware.</p>
</div></div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CorsError.html" title="actix_cors::CorsError enum">CorsError</a></div><div class="item-right docblock-short"><p>Errors that can occur when processing CORS guarded requests.</p>
</div></div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_cors" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
Deploying to gh-pages from @ 20ef05c36e9457b1f593831a06df68426db35b00 🚀
2021-06-27 08:05:12 +02:00
<script src="../main.js"></script>
</body></html>
Reference in New Issue Copy Permalink