mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-30 10:42:55 +01:00
47 lines
6.2 KiB
HTML
47 lines
6.2 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 a guard that matches requests targeting a specific host."><title>Host in actix_web::guard - 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" 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 fn"><!--[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/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/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_web/index.html">actix_web</a><span class="version">4.6.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_web::guard</a></h2></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>Function <a href="../index.html">actix_web</a>::<wbr><a href="index.html">guard</a>::<wbr><a class="fn" href="#">Host</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/guard/host.rs.html#58-63">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn Host(host: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>) -> HostGuard</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a guard that matches requests targeting a specific host.</p>
|
|||
|
|
<h2 id="matching-host"><a class="doc-anchor" href="#matching-host">§</a>Matching Host</h2>
|
|||
|
|
<p>This guard will:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>match against the <code>Host</code> header, if present;</li>
|
|||
|
|
<li>fall-back to matching against the request target’s host, if present;</li>
|
|||
|
|
<li>return false if host cannot be determined;</li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="matching-scheme"><a class="doc-anchor" href="#matching-scheme">§</a>Matching Scheme</h2>
|
|||
|
|
<p>Optionally, this guard can match against the host’s scheme. Set the scheme for matching using
|
|||
|
|
<code>Host(host).scheme(protocol)</code>. If the request’s scheme cannot be determined, it will not prevent
|
|||
|
|
the guard from matching successfully.</p>
|
|||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|||
|
|
<p>The <code>Host</code> guard can be used to set up a form of <a href="https://en.wikipedia.org/wiki/Virtual_hosting">virtual hosting</a> within a single app.
|
|||
|
|
Overlapping scope prefixes are usually discouraged, but when combined with non-overlapping guard
|
|||
|
|
definitions they become safe to use in this way. Without these host guards, only routes under
|
|||
|
|
the first-to-be-defined scope would be accessible. You can test this locally using <code>127.0.0.1</code>
|
|||
|
|
and <code>localhost</code> as the <code>Host</code> guards.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{web, http::Method, guard, App, HttpResponse};
|
|||
|
|
|
|||
|
|
App::new()
|
|||
|
|
.service(
|
|||
|
|
web::scope(<span class="string">""</span>)
|
|||
|
|
.guard(guard::Host(<span class="string">"www.rust-lang.org"</span>))
|
|||
|
|
.default_service(web::to(|| <span class="kw">async </span>{
|
|||
|
|
HttpResponse::Ok().body(<span class="string">"marketing site"</span>)
|
|||
|
|
})),
|
|||
|
|
)
|
|||
|
|
.service(
|
|||
|
|
web::scope(<span class="string">""</span>)
|
|||
|
|
.guard(guard::Host(<span class="string">"play.rust-lang.org"</span>))
|
|||
|
|
.default_service(web::to(|| <span class="kw">async </span>{
|
|||
|
|
HttpResponse::Ok().body(<span class="string">"playground frontend"</span>)
|
|||
|
|
})),
|
|||
|
|
);</code></pre></div>
|
|||
|
|
<p>The example below additionally guards on the host URI’s scheme. This could allow routing to
|
|||
|
|
different handlers for <code>http:</code> vs <code>https:</code> visitors; to redirect, for example.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{web, guard::Host, HttpResponse};
|
|||
|
|
|
|||
|
|
web::scope(<span class="string">"/admin"</span>)
|
|||
|
|
.guard(Host(<span class="string">"admin.rust-lang.org"</span>).scheme(<span class="string">"https"</span>))
|
|||
|
|
.default_service(web::to(|| <span class="kw">async </span>{
|
|||
|
|
HttpResponse::Ok().body(<span class="string">"admin connection is secure"</span>)
|
|||
|
|
}));</code></pre></div>
|
|||
|
|
</div></details></section></div></main></body></html>
|