mirror of
https://github.com/actix/actix-extras.git
synced 2025-03-12 16:42:49 +01:00
130 lines
9.6 KiB
HTML
130 lines
9.6 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="Source of the Rust file `actix-cors/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc source"><!--[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">☰</button><a class="sidebar-logo" href="../../actix_cors/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div>
|
||
</a><h2 class="location"></h2>
|
||
</nav>
|
||
<nav class="sidebar"><a class="sidebar-logo" href="../../actix_cors/index.html"><div class="logo-container">
|
||
<img src="https://actix.rs/img/logo.png" alt="logo"></div>
|
||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_cors/index.html">
|
||
<img src="https://actix.rs/img/logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
<span id="28">28</span>
|
||
<span id="29">29</span>
|
||
<span id="30">30</span>
|
||
<span id="31">31</span>
|
||
<span id="32">32</span>
|
||
<span id="33">33</span>
|
||
<span id="34">34</span>
|
||
<span id="35">35</span>
|
||
<span id="36">36</span>
|
||
<span id="37">37</span>
|
||
<span id="38">38</span>
|
||
<span id="39">39</span>
|
||
<span id="40">40</span>
|
||
<span id="41">41</span>
|
||
<span id="42">42</span>
|
||
<span id="43">43</span>
|
||
<span id="44">44</span>
|
||
<span id="45">45</span>
|
||
<span id="46">46</span>
|
||
<span id="47">47</span>
|
||
<span id="48">48</span>
|
||
<span id="49">49</span>
|
||
<span id="50">50</span>
|
||
<span id="51">51</span>
|
||
<span id="52">52</span>
|
||
<span id="53">53</span>
|
||
<span id="54">54</span>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
</pre><pre class="rust"><code><span class="doccomment">//! Cross-Origin Resource Sharing (CORS) controls for Actix Web.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! This middleware can be applied to both applications and resources. Once built, a</span>
|
||
<span class="doccomment">//! [`Cors`] builder can be used as an argument for Actix Web's `App::wrap()`,</span>
|
||
<span class="doccomment">//! `Scope::wrap()`, or `Resource::wrap()` methods.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! This CORS middleware automatically handles `OPTIONS` preflight requests.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! # Example</span>
|
||
<span class="doccomment">//! ```no_run</span>
|
||
<span class="doccomment">//! use actix_cors::Cors;</span>
|
||
<span class="doccomment">//! use actix_web::{get, http, web, App, HttpRequest, HttpResponse, HttpServer};</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! #[get("/index.html")]</span>
|
||
<span class="doccomment">//! async fn index(req: HttpRequest) -> &'static str {</span>
|
||
<span class="doccomment">//! "<p>Hello World!</p>"</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! #[actix_web::main]</span>
|
||
<span class="doccomment">//! async fn main() -> std::io::Result<()> {</span>
|
||
<span class="doccomment">//! HttpServer::new(|| {</span>
|
||
<span class="doccomment">//! let cors = Cors::default()</span>
|
||
<span class="doccomment">//! .allowed_origin("https://www.rust-lang.org/")</span>
|
||
<span class="doccomment">//! .allowed_origin_fn(|origin, _req_head| {</span>
|
||
<span class="doccomment">//! origin.as_bytes().ends_with(b".rust-lang.org")</span>
|
||
<span class="doccomment">//! })</span>
|
||
<span class="doccomment">//! .allowed_methods(vec!["GET", "POST"])</span>
|
||
<span class="doccomment">//! .allowed_headers(vec![http::header::AUTHORIZATION, http::header::ACCEPT])</span>
|
||
<span class="doccomment">//! .allowed_header(http::header::CONTENT_TYPE)</span>
|
||
<span class="doccomment">//! .max_age(3600);</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! App::new()</span>
|
||
<span class="doccomment">//! .wrap(cors)</span>
|
||
<span class="doccomment">//! .service(index)</span>
|
||
<span class="doccomment">//! })</span>
|
||
<span class="doccomment">//! .bind(("127.0.0.1", 8080))?</span>
|
||
<span class="doccomment">//! .run()</span>
|
||
<span class="doccomment">//! .await;</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! Ok(())</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//! ```</span>
|
||
|
||
<span class="attribute">#![<span class="ident">forbid</span>(<span class="ident">unsafe_code</span>)]</span>
|
||
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">rust_2018_idioms</span>, <span class="ident">nonstandard_style</span>)]</span>
|
||
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">future_incompatible</span>, <span class="ident">missing_docs</span>, <span class="ident">missing_debug_implementations</span>)]</span>
|
||
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_logo_url</span> <span class="op">=</span> <span class="string">"https://actix.rs/img/logo.png"</span>)]</span>
|
||
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_favicon_url</span> <span class="op">=</span> <span class="string">"https://actix.rs/favicon.ico"</span>)]</span>
|
||
|
||
<span class="kw">mod</span> <span class="ident">all_or_some</span>;
|
||
<span class="kw">mod</span> <span class="ident">builder</span>;
|
||
<span class="kw">mod</span> <span class="ident">error</span>;
|
||
<span class="kw">mod</span> <span class="ident">inner</span>;
|
||
<span class="kw">mod</span> <span class="ident">middleware</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">all_or_some::AllOrSome</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">builder::Cors</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">error::CorsError</span>;
|
||
<span class="kw">use</span> <span class="ident">inner</span>::{<span class="ident">Inner</span>, <span class="ident">OriginFn</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">middleware::CorsMiddleware</span>;
|
||
</code></pre></div>
|
||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_cors" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (f624427f8 2022-02-06)" ></div>
|
||
</body></html> |