mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-30 18:34:36 +01:00
45 lines
7.9 KiB
HTML
45 lines
7.9 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="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://actix.rs/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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" role="button">☰</div><a href='../actix_cors/index.html'><div class='logo-container'><img src='https://actix.rs/img/logo.png' alt='logo'></div></a><p class="location">Crate actix_cors</p><div class="block version"><p>Version 0.5.4</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><p class="location"></p><div id="sidebar-vars" data-name="actix_cors" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><button type="button" class="help-button">?</button>
|
|||
|
|
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">actix_cors</a></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">−</span>]</a></span><a class="srclink" href="../src/actix_cors/lib.rs.html#1-60" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Cross-Origin Resource Sharing (CORS) controls for Actix Web.</p>
|
|||
|
|
<p>This middleware can be applied to both applications and resources. Once built, a
|
|||
|
|
<a href="../actix_cors/struct.Cors.html" title="Cors"><code>Cors</code></a> builder can be used as an argument for Actix Web’s <code>App::wrap()</code>,
|
|||
|
|
<code>Scope::wrap()</code>, or <code>Resource::wrap()</code> methods.</p>
|
|||
|
|
<p>This CORS middleware automatically handles <code>OPTIONS</code> preflight requests.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_cors</span>::<span class="ident">Cors</span>;
|
|||
|
|
<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">"/index.html"</span>)]</span>
|
|||
|
|
<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>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> {
|
|||
|
|
<span class="string">"<p>Hello World!</p>"</span>
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="attribute">#[<span class="ident">actix_web</span>::<span class="ident">main</span>]</span>
|
|||
|
|
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
|||
|
|
<span class="ident">HttpServer</span>::<span class="ident">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</span>::<span class="ident">default</span>()
|
|||
|
|
.<span class="ident">allowed_origin</span>(<span class="string">"https://www.rust-lang.org/"</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".rust-lang.org"</span>)
|
|||
|
|
})
|
|||
|
|
.<span class="ident">allowed_methods</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"GET"</span>, <span class="string">"POST"</span>])
|
|||
|
|
.<span class="ident">allowed_headers</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">http</span>::<span class="ident">header</span>::<span class="ident">AUTHORIZATION</span>, <span class="ident">http</span>::<span class="ident">header</span>::<span class="ident">ACCEPT</span>])
|
|||
|
|
.<span class="ident">allowed_header</span>(<span class="ident">http</span>::<span class="ident">header</span>::<span class="ident">CONTENT_TYPE</span>)
|
|||
|
|
.<span class="ident">max_age</span>(<span class="number">3600</span>);
|
|||
|
|
|
|||
|
|
<span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<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">"127.0.0.1"</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>(())
|
|||
|
|
}</pre></div>
|
|||
|
|
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
|||
|
|
<table><tr class="module-item"><td><a class="struct" href="struct.Cors.html" title="actix_cors::Cors struct">Cors</a></td><td class="docblock-short"><p>Builder for CORS middleware.</p>
|
|||
|
|
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
|||
|
|
<table><tr class="module-item"><td><a class="enum" href="enum.CorsError.html" title="actix_cors::CorsError enum">CorsError</a></td><td class="docblock-short"><p>Errors that can occur when processing CORS guarded requests.</p>
|
|||
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_cors" data-search-js="../search-index.js"></div>
|
|||
|
|
<script src="../main.js"></script></body></html>
|