| <!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/percent-encoding-2.2.0/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" 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="../../percent_encoding/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="../../percent_encoding/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> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2013-2016 The rust-url developers. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! URLs use special characters to indicate the parts of the request. |
| //! For example, a `?` question mark marks the end of a path and the start of a query string. |
| //! In order for that character to exist inside a path, it needs to be encoded differently. |
| //! |
| //! Percent encoding replaces reserved characters with the `%` escape character |
| //! followed by a byte value as two hexadecimal digits. |
| //! For example, an ASCII space is replaced with `%20`. |
| //! |
| //! When encoding, the set of characters that can (and should, for readability) be left alone |
| //! depends on the context. |
| //! The `?` question mark mentioned above is not a separator when used literally |
| //! inside of a query string, and therefore does not need to be encoded. |
| //! The [`AsciiSet`] parameter of [`percent_encode`] and [`utf8_percent_encode`] |
| //! lets callers configure this. |
| //! |
| //! This crate deliberately does not provide many different sets. |
| //! Users should consider in what context the encoded string will be used, |
| //! read relevant specifications, and define their own set. |
| //! This is done by using the `add` method of an existing set. |
| //! |
| //! # Examples |
| //! |
| //! ``` |
| //! use percent_encoding::{utf8_percent_encode, AsciiSet, CONTROLS}; |
| //! |
| //! /// https://url.spec.whatwg.org/#fragment-percent-encode-set |
| //! const FRAGMENT: &AsciiSet = &CONTROLS.add(b' ').add(b'"').add(b'<').add(b'>').add(b'`'); |
| //! |
| //! assert_eq!(utf8_percent_encode("foo <bar>", FRAGMENT).to_string(), "foo%20%3Cbar%3E"); |
| //! ``` |
| |
| </span><span class="attribute">#![no_std] |
| #[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">use </span>alloc::{ |
| borrow::{Cow, ToOwned}, |
| string::String, |
| vec::Vec, |
| }; |
| <span class="kw">use </span>core::{fmt, mem, slice, str}; |
| |
| <span class="doccomment">/// Represents a set of characters or bytes in the ASCII range. |
| /// |
| /// This is used in [`percent_encode`] and [`utf8_percent_encode`]. |
| /// This is similar to [percent-encode sets](https://url.spec.whatwg.org/#percent-encoded-bytes). |
| /// |
| /// Use the `add` method of an existing set to define a new set. For example: |
| /// |
| /// ``` |
| /// use percent_encoding::{AsciiSet, CONTROLS}; |
| /// |
| /// /// https://url.spec.whatwg.org/#fragment-percent-encode-set |
| /// const FRAGMENT: &AsciiSet = &CONTROLS.add(b' ').add(b'"').add(b'<').add(b'>').add(b'`'); |
| /// ``` |
| </span><span class="kw">pub struct </span>AsciiSet { |
| mask: [Chunk; ASCII_RANGE_LEN / BITS_PER_CHUNK], |
| } |
| |
| <span class="kw">type </span>Chunk = u32; |
| |
| <span class="kw">const </span>ASCII_RANGE_LEN: usize = <span class="number">0x80</span>; |
| |
| <span class="kw">const </span>BITS_PER_CHUNK: usize = <span class="number">8 </span>* mem::size_of::<Chunk>(); |
| |
| <span class="kw">impl </span>AsciiSet { |
| <span class="doccomment">/// Called with UTF-8 bytes rather than code points. |
| /// Not used for non-ASCII bytes. |
| </span><span class="kw">const fn </span>contains(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> bool { |
| <span class="kw">let </span>chunk = <span class="self">self</span>.mask[byte <span class="kw">as </span>usize / BITS_PER_CHUNK]; |
| <span class="kw">let </span>mask = <span class="number">1 </span><< (byte <span class="kw">as </span>usize % BITS_PER_CHUNK); |
| (chunk & mask) != <span class="number">0 |
| </span>} |
| |
| <span class="kw">fn </span>should_percent_encode(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> bool { |
| !byte.is_ascii() || <span class="self">self</span>.contains(byte) |
| } |
| |
| <span class="kw">pub const fn </span>add(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> <span class="self">Self </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>mask = <span class="self">self</span>.mask; |
| mask[byte <span class="kw">as </span>usize / BITS_PER_CHUNK] |= <span class="number">1 </span><< (byte <span class="kw">as </span>usize % BITS_PER_CHUNK); |
| AsciiSet { mask } |
| } |
| |
| <span class="kw">pub const fn </span>remove(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> <span class="self">Self </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>mask = <span class="self">self</span>.mask; |
| mask[byte <span class="kw">as </span>usize / BITS_PER_CHUNK] &= !(<span class="number">1 </span><< (byte <span class="kw">as </span>usize % BITS_PER_CHUNK)); |
| AsciiSet { mask } |
| } |
| } |
| |
| <span class="doccomment">/// The set of 0x00 to 0x1F (C0 controls), and 0x7F (DEL). |
| /// |
| /// Note that this includes the newline and tab characters, but not the space 0x20. |
| /// |
| /// <https://url.spec.whatwg.org/#c0-control-percent-encode-set> |
| </span><span class="kw">pub const </span>CONTROLS: <span class="kw-2">&</span>AsciiSet = <span class="kw-2">&</span>AsciiSet { |
| mask: [ |
| !<span class="number">0_u32</span>, <span class="comment">// C0: 0x00 to 0x1F (32 bits set) |
| </span><span class="number">0</span>, |
| <span class="number">0</span>, |
| <span class="number">1 </span><< (<span class="number">0x7F_u32 </span>% <span class="number">32</span>), <span class="comment">// DEL: 0x7F (one bit set) |
| </span>], |
| }; |
| |
| <span class="macro">macro_rules! </span>static_assert { |
| ($( <span class="macro-nonterminal">$bool</span>: expr, )+) => { |
| <span class="kw">fn </span>_static_assert() { |
| $( |
| <span class="kw">let _ </span>= mem::transmute::<[u8; <span class="macro-nonterminal">$bool </span><span class="kw">as </span>usize], u8>; |
| )+ |
| } |
| } |
| } |
| |
| <span class="macro">static_assert! </span>{ |
| CONTROLS.contains(<span class="number">0x00</span>), |
| CONTROLS.contains(<span class="number">0x1F</span>), |
| !CONTROLS.contains(<span class="number">0x20</span>), |
| !CONTROLS.contains(<span class="number">0x7E</span>), |
| CONTROLS.contains(<span class="number">0x7F</span>), |
| } |
| |
| <span class="doccomment">/// Everything that is not an ASCII letter or digit. |
| /// |
| /// This is probably more eager than necessary in any context. |
| </span><span class="kw">pub const </span>NON_ALPHANUMERIC: <span class="kw-2">&</span>AsciiSet = <span class="kw-2">&</span>CONTROLS |
| .add(<span class="string">b' '</span>) |
| .add(<span class="string">b'!'</span>) |
| .add(<span class="string">b'"'</span>) |
| .add(<span class="string">b'#'</span>) |
| .add(<span class="string">b'$'</span>) |
| .add(<span class="string">b'%'</span>) |
| .add(<span class="string">b'&'</span>) |
| .add(<span class="string">b'\''</span>) |
| .add(<span class="string">b'('</span>) |
| .add(<span class="string">b')'</span>) |
| .add(<span class="string">b'*'</span>) |
| .add(<span class="string">b'+'</span>) |
| .add(<span class="string">b','</span>) |
| .add(<span class="string">b'-'</span>) |
| .add(<span class="string">b'.'</span>) |
| .add(<span class="string">b'/'</span>) |
| .add(<span class="string">b':'</span>) |
| .add(<span class="string">b';'</span>) |
| .add(<span class="string">b'<'</span>) |
| .add(<span class="string">b'='</span>) |
| .add(<span class="string">b'>'</span>) |
| .add(<span class="string">b'?'</span>) |
| .add(<span class="string">b'@'</span>) |
| .add(<span class="string">b'['</span>) |
| .add(<span class="string">b'\\'</span>) |
| .add(<span class="string">b']'</span>) |
| .add(<span class="string">b'^'</span>) |
| .add(<span class="string">b'_'</span>) |
| .add(<span class="string">b'`'</span>) |
| .add(<span class="string">b'{'</span>) |
| .add(<span class="string">b'|'</span>) |
| .add(<span class="string">b'}'</span>) |
| .add(<span class="string">b'~'</span>); |
| |
| <span class="doccomment">/// Return the percent-encoding of the given byte. |
| /// |
| /// This is unconditional, unlike `percent_encode()` which has an `AsciiSet` parameter. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use percent_encoding::percent_encode_byte; |
| /// |
| /// assert_eq!("foo bar".bytes().map(percent_encode_byte).collect::<String>(), |
| /// "%66%6F%6F%20%62%61%72"); |
| /// ``` |
| </span><span class="kw">pub fn </span>percent_encode_byte(byte: u8) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| <span class="kw">let </span>index = usize::from(byte) * <span class="number">3</span>; |
| <span class="kw-2">&</span><span class="string">"\ |
| %00%01%02%03%04%05%06%07%08%09%0A%0B%0C%0D%0E%0F\ |
| %10%11%12%13%14%15%16%17%18%19%1A%1B%1C%1D%1E%1F\ |
| %20%21%22%23%24%25%26%27%28%29%2A%2B%2C%2D%2E%2F\ |
| %30%31%32%33%34%35%36%37%38%39%3A%3B%3C%3D%3E%3F\ |
| %40%41%42%43%44%45%46%47%48%49%4A%4B%4C%4D%4E%4F\ |
| %50%51%52%53%54%55%56%57%58%59%5A%5B%5C%5D%5E%5F\ |
| %60%61%62%63%64%65%66%67%68%69%6A%6B%6C%6D%6E%6F\ |
| %70%71%72%73%74%75%76%77%78%79%7A%7B%7C%7D%7E%7F\ |
| %80%81%82%83%84%85%86%87%88%89%8A%8B%8C%8D%8E%8F\ |
| %90%91%92%93%94%95%96%97%98%99%9A%9B%9C%9D%9E%9F\ |
| %A0%A1%A2%A3%A4%A5%A6%A7%A8%A9%AA%AB%AC%AD%AE%AF\ |
| %B0%B1%B2%B3%B4%B5%B6%B7%B8%B9%BA%BB%BC%BD%BE%BF\ |
| %C0%C1%C2%C3%C4%C5%C6%C7%C8%C9%CA%CB%CC%CD%CE%CF\ |
| %D0%D1%D2%D3%D4%D5%D6%D7%D8%D9%DA%DB%DC%DD%DE%DF\ |
| %E0%E1%E2%E3%E4%E5%E6%E7%E8%E9%EA%EB%EC%ED%EE%EF\ |
| %F0%F1%F2%F3%F4%F5%F6%F7%F8%F9%FA%FB%FC%FD%FE%FF\ |
| "</span>[index..index + <span class="number">3</span>] |
| } |
| |
| <span class="doccomment">/// Percent-encode the given bytes with the given set. |
| /// |
| /// Non-ASCII bytes and bytes in `ascii_set` are encoded. |
| /// |
| /// The return type: |
| /// |
| /// * Implements `Iterator<Item = &str>` and therefore has a `.collect::<String>()` method, |
| /// * Implements `Display` and therefore has a `.to_string()` method, |
| /// * Implements `Into<Cow<str>>` borrowing `input` when none of its bytes are encoded. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use percent_encoding::{percent_encode, NON_ALPHANUMERIC}; |
| /// |
| /// assert_eq!(percent_encode(b"foo bar?", NON_ALPHANUMERIC).to_string(), "foo%20bar%3F"); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>percent_encode<<span class="lifetime">'a</span>>(input: <span class="kw-2">&</span><span class="lifetime">'a </span>[u8], ascii_set: <span class="kw-2">&</span><span class="lifetime">'static </span>AsciiSet) -> PercentEncode<<span class="lifetime">'a</span>> { |
| PercentEncode { |
| bytes: input, |
| ascii_set, |
| } |
| } |
| |
| <span class="doccomment">/// Percent-encode the UTF-8 encoding of the given string. |
| /// |
| /// See [`percent_encode`] regarding the return type. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use percent_encoding::{utf8_percent_encode, NON_ALPHANUMERIC}; |
| /// |
| /// assert_eq!(utf8_percent_encode("foo bar?", NON_ALPHANUMERIC).to_string(), "foo%20bar%3F"); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>utf8_percent_encode<<span class="lifetime">'a</span>>(input: <span class="kw-2">&</span><span class="lifetime">'a </span>str, ascii_set: <span class="kw-2">&</span><span class="lifetime">'static </span>AsciiSet) -> PercentEncode<<span class="lifetime">'a</span>> { |
| percent_encode(input.as_bytes(), ascii_set) |
| } |
| |
| <span class="doccomment">/// The return type of [`percent_encode`] and [`utf8_percent_encode`]. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>PercentEncode<<span class="lifetime">'a</span>> { |
| bytes: <span class="kw-2">&</span><span class="lifetime">'a </span>[u8], |
| ascii_set: <span class="kw-2">&</span><span class="lifetime">'static </span>AsciiSet, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>PercentEncode<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>str; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>((<span class="kw-2">&</span>first_byte, remaining)) = <span class="self">self</span>.bytes.split_first() { |
| <span class="kw">if </span><span class="self">self</span>.ascii_set.should_percent_encode(first_byte) { |
| <span class="self">self</span>.bytes = remaining; |
| <span class="prelude-val">Some</span>(percent_encode_byte(first_byte)) |
| } <span class="kw">else </span>{ |
| <span class="comment">// The unsafe blocks here are appropriate because the bytes are |
| // confirmed as a subset of UTF-8 in should_percent_encode. |
| </span><span class="kw">for </span>(i, <span class="kw-2">&</span>byte) <span class="kw">in </span>remaining.iter().enumerate() { |
| <span class="kw">if </span><span class="self">self</span>.ascii_set.should_percent_encode(byte) { |
| <span class="comment">// 1 for first_byte + i for previous iterations of this loop |
| </span><span class="kw">let </span>(unchanged_slice, remaining) = <span class="self">self</span>.bytes.split_at(<span class="number">1 </span>+ i); |
| <span class="self">self</span>.bytes = remaining; |
| <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ str::from_utf8_unchecked(unchanged_slice) }); |
| } |
| } |
| <span class="kw">let </span>unchanged_slice = <span class="self">self</span>.bytes; |
| <span class="self">self</span>.bytes = <span class="kw-2">&</span>[][..]; |
| <span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ str::from_utf8_unchecked(unchanged_slice) }) |
| } |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="kw">if </span><span class="self">self</span>.bytes.is_empty() { |
| (<span class="number">0</span>, <span class="prelude-val">Some</span>(<span class="number">0</span>)) |
| } <span class="kw">else </span>{ |
| (<span class="number">1</span>, <span class="prelude-val">Some</span>(<span class="self">self</span>.bytes.len())) |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> fmt::Display <span class="kw">for </span>PercentEncode<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">for </span>c <span class="kw">in </span>(<span class="kw-2">*</span><span class="self">self</span>).clone() { |
| formatter.write_str(c)<span class="question-mark">? |
| </span>} |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> From<PercentEncode<<span class="lifetime">'a</span>>> <span class="kw">for </span>Cow<<span class="lifetime">'a</span>, str> { |
| <span class="kw">fn </span>from(<span class="kw-2">mut </span>iter: PercentEncode<<span class="lifetime">'a</span>>) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>iter.next() { |
| <span class="prelude-val">None </span>=> <span class="string">""</span>.into(), |
| <span class="prelude-val">Some</span>(first) => <span class="kw">match </span>iter.next() { |
| <span class="prelude-val">None </span>=> first.into(), |
| <span class="prelude-val">Some</span>(second) => { |
| <span class="kw">let </span><span class="kw-2">mut </span>string = first.to_owned(); |
| string.push_str(second); |
| string.extend(iter); |
| string.into() |
| } |
| }, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Percent-decode the given string. |
| /// |
| /// <https://url.spec.whatwg.org/#string-percent-decode> |
| /// |
| /// See [`percent_decode`] regarding the return type. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>percent_decode_str(input: <span class="kw-2">&</span>str) -> PercentDecode<<span class="lifetime">'_</span>> { |
| percent_decode(input.as_bytes()) |
| } |
| |
| <span class="doccomment">/// Percent-decode the given bytes. |
| /// |
| /// <https://url.spec.whatwg.org/#percent-decode> |
| /// |
| /// Any sequence of `%` followed by two hexadecimal digits is decoded. |
| /// The return type: |
| /// |
| /// * Implements `Into<Cow<u8>>` borrowing `input` when it contains no percent-encoded sequence, |
| /// * Implements `Iterator<Item = u8>` and therefore has a `.collect::<Vec<u8>>()` method, |
| /// * Has `decode_utf8()` and `decode_utf8_lossy()` methods. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use percent_encoding::percent_decode; |
| /// |
| /// assert_eq!(percent_decode(b"foo%20bar%3f").decode_utf8().unwrap(), "foo bar?"); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>percent_decode(input: <span class="kw-2">&</span>[u8]) -> PercentDecode<<span class="lifetime">'_</span>> { |
| PercentDecode { |
| bytes: input.iter(), |
| } |
| } |
| |
| <span class="doccomment">/// The return type of [`percent_decode`]. |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>PercentDecode<<span class="lifetime">'a</span>> { |
| bytes: slice::Iter<<span class="lifetime">'a</span>, u8>, |
| } |
| |
| <span class="kw">fn </span>after_percent_sign(iter: <span class="kw-2">&mut </span>slice::Iter<<span class="lifetime">'_</span>, u8>) -> <span class="prelude-ty">Option</span><u8> { |
| <span class="kw">let </span><span class="kw-2">mut </span>cloned_iter = iter.clone(); |
| <span class="kw">let </span>h = char::from(<span class="kw-2">*</span>cloned_iter.next()<span class="question-mark">?</span>).to_digit(<span class="number">16</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>l = char::from(<span class="kw-2">*</span>cloned_iter.next()<span class="question-mark">?</span>).to_digit(<span class="number">16</span>)<span class="question-mark">?</span>; |
| <span class="kw-2">*</span>iter = cloned_iter; |
| <span class="prelude-val">Some</span>(h <span class="kw">as </span>u8 * <span class="number">0x10 </span>+ l <span class="kw">as </span>u8) |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>PercentDecode<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = u8; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u8> { |
| <span class="self">self</span>.bytes.next().map(|<span class="kw-2">&</span>byte| { |
| <span class="kw">if </span>byte == <span class="string">b'%' </span>{ |
| after_percent_sign(<span class="kw-2">&mut </span><span class="self">self</span>.bytes).unwrap_or(byte) |
| } <span class="kw">else </span>{ |
| byte |
| } |
| }) |
| } |
| |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="kw">let </span>bytes = <span class="self">self</span>.bytes.len(); |
| ((bytes + <span class="number">2</span>) / <span class="number">3</span>, <span class="prelude-val">Some</span>(bytes)) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> From<PercentDecode<<span class="lifetime">'a</span>>> <span class="kw">for </span>Cow<<span class="lifetime">'a</span>, [u8]> { |
| <span class="kw">fn </span>from(iter: PercentDecode<<span class="lifetime">'a</span>>) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>iter.if_any() { |
| <span class="prelude-val">Some</span>(vec) => Cow::Owned(vec), |
| <span class="prelude-val">None </span>=> Cow::Borrowed(iter.bytes.as_slice()), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> PercentDecode<<span class="lifetime">'a</span>> { |
| <span class="doccomment">/// If the percent-decoding is different from the input, return it as a new bytes vector. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">fn </span>if_any(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Vec<u8>> { |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes_iter = <span class="self">self</span>.bytes.clone(); |
| <span class="kw">while </span>bytes_iter.any(|<span class="kw-2">&</span>b| b == <span class="string">b'%'</span>) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(decoded_byte) = after_percent_sign(<span class="kw-2">&mut </span>bytes_iter) { |
| <span class="kw">let </span>initial_bytes = <span class="self">self</span>.bytes.as_slice(); |
| <span class="kw">let </span>unchanged_bytes_len = initial_bytes.len() - bytes_iter.len() - <span class="number">3</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>decoded = initial_bytes[..unchanged_bytes_len].to_owned(); |
| decoded.push(decoded_byte); |
| decoded.extend(PercentDecode { bytes: bytes_iter }); |
| <span class="kw">return </span><span class="prelude-val">Some</span>(decoded); |
| } |
| } |
| <span class="comment">// Nothing to decode |
| </span><span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Decode the result of percent-decoding as UTF-8. |
| /// |
| /// This is return `Err` when the percent-decoded bytes are not well-formed in UTF-8. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">pub fn </span>decode_utf8(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><Cow<<span class="lifetime">'a</span>, str>, str::Utf8Error> { |
| <span class="kw">match </span><span class="self">self</span>.clone().into() { |
| Cow::Borrowed(bytes) => <span class="kw">match </span>str::from_utf8(bytes) { |
| <span class="prelude-val">Ok</span>(s) => <span class="prelude-val">Ok</span>(s.into()), |
| <span class="prelude-val">Err</span>(e) => <span class="prelude-val">Err</span>(e), |
| }, |
| Cow::Owned(bytes) => <span class="kw">match </span>String::from_utf8(bytes) { |
| <span class="prelude-val">Ok</span>(s) => <span class="prelude-val">Ok</span>(s.into()), |
| <span class="prelude-val">Err</span>(e) => <span class="prelude-val">Err</span>(e.utf8_error()), |
| }, |
| } |
| } |
| |
| <span class="doccomment">/// Decode the result of percent-decoding as UTF-8, lossily. |
| /// |
| /// Invalid UTF-8 percent-encoded byte sequences will be replaced � U+FFFD, |
| /// the replacement character. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">pub fn </span>decode_utf8_lossy(<span class="self">self</span>) -> Cow<<span class="lifetime">'a</span>, str> { |
| decode_utf8_lossy(<span class="self">self</span>.clone().into()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"alloc"</span>)] |
| </span><span class="kw">fn </span>decode_utf8_lossy(input: Cow<<span class="lifetime">'_</span>, [u8]>) -> Cow<<span class="lifetime">'_</span>, str> { |
| <span class="comment">// Note: This function is duplicated in `form_urlencoded/src/query_encoding.rs`. |
| </span><span class="kw">match </span>input { |
| Cow::Borrowed(bytes) => String::from_utf8_lossy(bytes), |
| Cow::Owned(bytes) => { |
| <span class="kw">match </span>String::from_utf8_lossy(<span class="kw-2">&</span>bytes) { |
| Cow::Borrowed(utf8) => { |
| <span class="comment">// If from_utf8_lossy returns a Cow::Borrowed, then we can |
| // be sure our original bytes were valid UTF-8. This is because |
| // if the bytes were invalid UTF-8 from_utf8_lossy would have |
| // to allocate a new owned string to back the Cow so it could |
| // replace invalid bytes with a placeholder. |
| |
| // First we do a debug_assert to confirm our description above. |
| </span><span class="kw">let </span>raw_utf8: <span class="kw-2">*const </span>[u8] = utf8.as_bytes(); |
| <span class="macro">debug_assert!</span>(raw_utf8 == <span class="kw-2">&*</span>bytes <span class="kw">as </span><span class="kw-2">*const </span>[u8]); |
| |
| <span class="comment">// Given we know the original input bytes are valid UTF-8, |
| // and we have ownership of those bytes, we re-use them and |
| // return a Cow::Owned here. |
| </span>Cow::Owned(<span class="kw">unsafe </span>{ String::from_utf8_unchecked(bytes) }) |
| } |
| Cow::Owned(s) => Cow::Owned(s), |
| } |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="percent_encoding" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
