Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / url / origin.rs.html
blob: 520b97c37b0051c07ff1ce746b54b3a39a727ea8 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/url-2.3.1/src/origin.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>origin.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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="sidebar"><a class="sidebar-logo" href="../../url/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../url/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2016 The rust-url developers.
//
// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
</span><span class="kw">use </span><span class="kw">crate</span>::host::Host;
<span class="kw">use </span><span class="kw">crate</span>::parser::default_port;
<span class="kw">use </span><span class="kw">crate</span>::Url;
<span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<span class="kw">pub fn </span>url_origin(url: <span class="kw-2">&amp;</span>Url) -&gt; Origin {
<span class="kw">let </span>scheme = url.scheme();
<span class="kw">match </span>scheme {
<span class="string">&quot;blob&quot; </span>=&gt; {
<span class="kw">let </span>result = Url::parse(url.path());
<span class="kw">match </span>result {
<span class="prelude-val">Ok</span>(<span class="kw-2">ref </span>url) =&gt; url_origin(url),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; Origin::new_opaque(),
}
}
<span class="string">&quot;ftp&quot; </span>| <span class="string">&quot;http&quot; </span>| <span class="string">&quot;https&quot; </span>| <span class="string">&quot;ws&quot; </span>| <span class="string">&quot;wss&quot; </span>=&gt; Origin::Tuple(
scheme.to_owned(),
url.host().unwrap().to_owned(),
url.port_or_known_default().unwrap(),
),
<span class="comment">// TODO: Figure out what to do if the scheme is a file
</span><span class="string">&quot;file&quot; </span>=&gt; Origin::new_opaque(),
<span class="kw">_ </span>=&gt; Origin::new_opaque(),
}
}
<span class="doccomment">/// The origin of an URL
///
/// Two URLs with the same origin are considered
/// to originate from the same entity and can therefore trust
/// each other.
///
/// The origin is determined based on the scheme as follows:
///
/// - If the scheme is &quot;blob&quot; the origin is the origin of the
/// URL contained in the path component. If parsing fails,
/// it is an opaque origin.
/// - If the scheme is &quot;ftp&quot;, &quot;http&quot;, &quot;https&quot;, &quot;ws&quot;, or &quot;wss&quot;,
/// then the origin is a tuple of the scheme, host, and port.
/// - If the scheme is anything else, the origin is opaque, meaning
/// the URL does not have the same origin as any other URL.
///
/// For more information see &lt;https://url.spec.whatwg.org/#origin&gt;
</span><span class="attribute">#[derive(PartialEq, Eq, Hash, Clone, Debug)]
</span><span class="kw">pub enum </span>Origin {
<span class="doccomment">/// A globally unique identifier
</span>Opaque(OpaqueOrigin),
<span class="doccomment">/// Consists of the URL&#39;s scheme, host and port
</span>Tuple(String, Host&lt;String&gt;, u16),
}
<span class="kw">impl </span>Origin {
<span class="doccomment">/// Creates a new opaque origin that is only equal to itself.
</span><span class="kw">pub fn </span>new_opaque() -&gt; Origin {
<span class="kw">static </span>COUNTER: AtomicUsize = AtomicUsize::new(<span class="number">0</span>);
Origin::Opaque(OpaqueOrigin(COUNTER.fetch_add(<span class="number">1</span>, Ordering::SeqCst)))
}
<span class="doccomment">/// Return whether this origin is a (scheme, host, port) tuple
/// (as opposed to an opaque origin).
</span><span class="kw">pub fn </span>is_tuple(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="macro">matches!</span>(<span class="kw-2">*</span><span class="self">self</span>, Origin::Tuple(..))
}
<span class="doccomment">/// &lt;https://html.spec.whatwg.org/multipage/#ascii-serialisation-of-an-origin&gt;
</span><span class="kw">pub fn </span>ascii_serialization(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; String {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Origin::Opaque(<span class="kw">_</span>) =&gt; <span class="string">&quot;null&quot;</span>.to_owned(),
Origin::Tuple(<span class="kw-2">ref </span>scheme, <span class="kw-2">ref </span>host, port) =&gt; {
<span class="kw">if </span>default_port(scheme) == <span class="prelude-val">Some</span>(port) {
<span class="macro">format!</span>(<span class="string">&quot;{}://{}&quot;</span>, scheme, host)
} <span class="kw">else </span>{
<span class="macro">format!</span>(<span class="string">&quot;{}://{}:{}&quot;</span>, scheme, host, port)
}
}
}
}
<span class="doccomment">/// &lt;https://html.spec.whatwg.org/multipage/#unicode-serialisation-of-an-origin&gt;
</span><span class="kw">pub fn </span>unicode_serialization(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; String {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Origin::Opaque(<span class="kw">_</span>) =&gt; <span class="string">&quot;null&quot;</span>.to_owned(),
Origin::Tuple(<span class="kw-2">ref </span>scheme, <span class="kw-2">ref </span>host, port) =&gt; {
<span class="kw">let </span>host = <span class="kw">match </span><span class="kw-2">*</span>host {
Host::Domain(<span class="kw-2">ref </span>domain) =&gt; {
<span class="kw">let </span>(domain, _errors) = idna::domain_to_unicode(domain);
Host::Domain(domain)
}
<span class="kw">_ </span>=&gt; host.clone(),
};
<span class="kw">if </span>default_port(scheme) == <span class="prelude-val">Some</span>(port) {
<span class="macro">format!</span>(<span class="string">&quot;{}://{}&quot;</span>, scheme, host)
} <span class="kw">else </span>{
<span class="macro">format!</span>(<span class="string">&quot;{}://{}:{}&quot;</span>, scheme, host, port)
}
}
}
}
}
<span class="doccomment">/// Opaque identifier for URLs that have file or other schemes
</span><span class="attribute">#[derive(Eq, PartialEq, Hash, Clone, Debug)]
</span><span class="kw">pub struct </span>OpaqueOrigin(usize);
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="url" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>