actix-extras/actix_cors/index.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."><title>actix_cors - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9e1300b5663a8a03.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_cors" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0-nightly (ab5bda1aa 2024-04-08)" data-channel="nightly" data-search-js="search-ffac13a0df2b1870.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-c97aec732c613ca4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../actix_cors/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_cors/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_cors/index.html">actix_cors</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><ul class="block">
            <li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
    <main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../actix_cors/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">actix_cors</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/actix_cors/lib.rs.html#1-68">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="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>
<p>This middleware can be applied to both applications and resources. Once built, a <a href="struct.Cors.html" title="struct actix_cors::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>
<h2 id="crate-features"><a class="doc-anchor" href="#crate-features">§</a>Crate Features</h2>
<ul>
<li><code>draft-private-network-access</code>: ⚠️ Unstable. Adds opt-in support for the <a href="https://wicg.github.io/private-network-access">Private Network
Access</a> spec extensions. This feature is unstable since it will follow breaking changes in the
draft spec until it is finalized.</li>
</ul>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_cors::Cors;
<span class="kw">use </span>actix_web::{get, http, web, App, HttpRequest, HttpResponse, HttpServer};

<span class="attr">#[get(<span class="string">"/index.html"</span>)]
</span><span class="kw">async fn </span>index(req: HttpRequest) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'static </span>str {
    <span class="string">"&lt;p&gt;Hello World!&lt;/p&gt;"
</span>}

<span class="attr">#[actix_web::main]
</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
    HttpServer::new(|| {
        <span class="kw">let </span>cors = Cors::default()
            .allowed_origin(<span class="string">"https://www.rust-lang.org"</span>)
            .allowed_origin_fn(|origin, _req_head| {
                origin.as_bytes().ends_with(<span class="string">b".rust-lang.org"</span>)
            })
            .allowed_methods(<span class="macro">vec!</span>[<span class="string">"GET"</span>, <span class="string">"POST"</span>])
            .allowed_headers(<span class="macro">vec!</span>[http::header::AUTHORIZATION, http::header::ACCEPT])
            .allowed_header(http::header::CONTENT_TYPE)
            .max_age(<span class="number">3600</span>);

        App::new()
            .wrap(cors)
            .service(index)
    })
    .bind((<span class="string">"127.0.0.1"</span>, <span class="number">8080</span>))<span class="question-mark">?
    </span>.run()
    .<span class="kw">await</span>;

    <span class="prelude-val">Ok</span>(())
}</code></pre></div>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.CorsMiddleware"><code>pub use crate::middleware::CorsMiddleware;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Cors.html" title="struct actix_cors::Cors">Cors</a></div><div class="desc docblock-short">Builder for CORS middleware.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.CorsError.html" title="enum actix_cors::CorsError">CorsError</a></div><div class="desc docblock-short">Errors that can occur when processing CORS guarded requests.</div></li></ul></section></div></main></body></html>
-												Deploying to gh-pages from @ actix/actix-extras@9ddb95b74a71ffc781ce02b7f0cfabbdca931401 🚀

											
										
										
											2024-04-09 12:20:01 +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."><title>actix_cors - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9e1300b5663a8a03.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_cors" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0-nightly (ab5bda1aa 2024-04-08)" data-channel="nightly" data-search-js="search-ffac13a0df2b1870.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-c97aec732c613ca4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../actix_cors/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_cors/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_cors/index.html">actix_cors</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><ul class="block">
-												Deploying to gh-pages from @ actix/actix-extras@5bf831c27bf4ebdd84d63fa500e3676daa8738ac 🚀

											
										
										
											2023-12-18 17:32:00 +01:00
+								            <li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
 								    <main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../actix_cors/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">actix_cors</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/actix_cors/lib.rs.html#1-68">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="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  @ 218f18e69d8dbc3df9d5ccf92b6fcc192713494b 🚀

											
										
										
											2023-03-22 21:53:05 +01:00
+								<p>This middleware can be applied to both applications and resources. Once built, a <a href="struct.Cors.html" title="struct actix_cors::Cors"><code>Cors</code></a>
-												Deploying to gh-pages from  @ ac444ca798694dfeeab002c9bf422469622a17ee 🚀

											
										
										
											2022-10-29 00:47:36 +02:00
+								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>
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
+								<p>This CORS middleware automatically handles <code>OPTIONS</code> preflight requests.</p>
-												Deploying to gh-pages from @ actix/actix-extras@254d4084a99d3533395c3d5e9577dc4324cb9202 🚀

											
										
										
											2024-01-22 17:07:28 +01:00
+								<h2 id="crate-features"><a class="doc-anchor" href="#crate-features">§</a>Crate Features</h2>
-												Deploying to gh-pages from  @ ac444ca798694dfeeab002c9bf422469622a17ee 🚀

											
										
										
											2022-10-29 00:47:36 +02:00
+								<ul>
-												Deploying to gh-pages from  @ 8a31f3020e48e4a691524637cdb71496294b5ec8 🚀

											
										
										
											2023-04-09 21:03:56 +02:00
+								<li><code>draft-private-network-access</code>: ⚠️ Unstable. Adds opt-in support for the <a href="https://wicg.github.io/private-network-access">Private Network
 								Access</a> spec extensions. This feature is unstable since it will follow breaking changes in the
-												Deploying to gh-pages from  @ f37c93a2a8895cee2ed9697778bae91310a9a012 🚀

											
										
										
											2023-04-09 20:43:48 +02:00
+								draft spec until it is finalized.</li>
-												Deploying to gh-pages from  @ ac444ca798694dfeeab002c9bf422469622a17ee 🚀

											
										
										
											2022-10-29 00:47:36 +02:00
+								</ul>
-												Deploying to gh-pages from @ actix/actix-extras@254d4084a99d3533395c3d5e9577dc4324cb9202 🚀

											
										
										
											2024-01-22 17:07:28 +01:00
+								<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
-												Deploying to gh-pages from  @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀

											
										
										
											2022-08-24 19:10:06 +02:00
+								<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_cors::Cors;
 								<span class="kw">use </span>actix_web::{get, http, web, App, HttpRequest, HttpResponse, HttpServer};
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
-												Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀

											
										
										
											2023-12-06 15:01:24 +01:00
+								<span class="attr">#[get(<span class="string">"/index.html"</span>)]
 								</span><span class="kw">async fn </span>index(req: HttpRequest) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'static </span>str {
 								    <span class="string">"&lt;p&gt;Hello World!&lt;/p&gt;"
-												Deploying to gh-pages from  @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀

											
										
										
											2022-08-24 19:10:06 +02:00
+								</span>}
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
-												Deploying to gh-pages from  @ 8fd166435fa1247bdd34cc448ac84d776edbee50 🚀

											
										
										
											2022-11-08 10:33:31 +01:00
+								<span class="attr">#[actix_web::main]
-												Deploying to gh-pages from  @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀

											
										
										
											2022-08-24 19:10:06 +02:00
+								</span><span class="kw">async fn </span>main() -&gt; std::io::Result&lt;()&gt; {
 								    HttpServer::new(|| {
 								        <span class="kw">let </span>cors = Cors::default()
-												Deploying to gh-pages from @ actix/actix-extras@8b4e8ea34e0c6c85d1e06300e4f9876fc1df1ed0 🚀

											
										
										
											2024-01-11 05:28:55 +01:00
+								            .allowed_origin(<span class="string">"https://www.rust-lang.org"</span>)
 								            .allowed_origin_fn(|origin, _req_head| {
 								                origin.as_bytes().ends_with(<span class="string">b".rust-lang.org"</span>)
 								            })
 								            .allowed_methods(<span class="macro">vec!</span>[<span class="string">"GET"</span>, <span class="string">"POST"</span>])
 								            .allowed_headers(<span class="macro">vec!</span>[http::header::AUTHORIZATION, http::header::ACCEPT])
 								            .allowed_header(http::header::CONTENT_TYPE)
 								            .max_age(<span class="number">3600</span>);
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
-												Deploying to gh-pages from  @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀

											
										
										
											2022-08-24 19:10:06 +02:00
+								        App::new()
 								            .wrap(cors)
 								            .service(index)
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
+								    })
-												Deploying to gh-pages from @ actix/actix-extras@2f30fd71a91264e596855afe03a533cee8e408ba 🚀

											
										
										
											2023-12-06 15:01:24 +01:00
+								    .bind((<span class="string">"127.0.0.1"</span>, <span class="number">8080</span>))<span class="question-mark">?
-												Deploying to gh-pages from  @ 1e682e7a594b6a9d7557012f93f060db597c1a33 🚀

											
										
										
											2022-08-24 19:10:06 +02:00
+								    </span>.run()
-												Deploying to gh-pages from  @ c7df62d0b67d43e271512ed9bc857fce987b3629 🚀

											
										
										
											2021-03-22 12:49:07 +01:00
+								    .<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 @ actix/actix-extras@254d4084a99d3533395c3d5e9577dc4324cb9202 🚀

											
										
										
											2024-01-22 17:07:28 +01:00
+								</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.CorsMiddleware"><code>pub use crate::middleware::CorsMiddleware;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Cors.html" title="struct actix_cors::Cors">Cors</a></div><div class="desc docblock-short">Builder for CORS middleware.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.CorsError.html" title="enum actix_cors::CorsError">CorsError</a></div><div class="desc docblock-short">Errors that can occur when processing CORS guarded requests.</div></li></ul></section></div></main></body></html>