summaryrefslogtreecommitdiffstats
path: root/vendor/percent-encoding
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/percent-encoding
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/percent-encoding')
-rw-r--r--vendor/percent-encoding/.cargo-checksum.json1
-rw-r--r--vendor/percent-encoding/Cargo.toml23
-rw-r--r--vendor/percent-encoding/LICENSE-APACHE201
-rw-r--r--vendor/percent-encoding/LICENSE-MIT25
-rw-r--r--vendor/percent-encoding/lib.rs442
5 files changed, 692 insertions, 0 deletions
diff --git a/vendor/percent-encoding/.cargo-checksum.json b/vendor/percent-encoding/.cargo-checksum.json
new file mode 100644
index 000000000..7576f0fde
--- /dev/null
+++ b/vendor/percent-encoding/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"dd59f4e6c033f011625ede444aa27fc8df4be53297af238b4f76d05144de5878","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"20c7855c364d57ea4c97889a5e8d98470a9952dade37bd9248b9a54431670e5e","lib.rs":"b9dd3a27fb0f56aebe3c4c411ea768a106a54e480ac08d9023c35bbba0bdcbdc"},"package":"d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e"} \ No newline at end of file
diff --git a/vendor/percent-encoding/Cargo.toml b/vendor/percent-encoding/Cargo.toml
new file mode 100644
index 000000000..b51d1d449
--- /dev/null
+++ b/vendor/percent-encoding/Cargo.toml
@@ -0,0 +1,23 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+name = "percent-encoding"
+version = "2.1.0"
+authors = ["The rust-url developers"]
+description = "Percent encoding and decoding"
+license = "MIT/Apache-2.0"
+repository = "https://github.com/servo/rust-url/"
+
+[lib]
+path = "lib.rs"
+test = false
diff --git a/vendor/percent-encoding/LICENSE-APACHE b/vendor/percent-encoding/LICENSE-APACHE
new file mode 100644
index 000000000..16fe87b06
--- /dev/null
+++ b/vendor/percent-encoding/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/vendor/percent-encoding/LICENSE-MIT b/vendor/percent-encoding/LICENSE-MIT
new file mode 100644
index 000000000..24de6b418
--- /dev/null
+++ b/vendor/percent-encoding/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2013-2016 The rust-url developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/vendor/percent-encoding/lib.rs b/vendor/percent-encoding/lib.rs
new file mode 100644
index 000000000..27eaf6740
--- /dev/null
+++ b/vendor/percent-encoding/lib.rs
@@ -0,0 +1,442 @@
+// 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.
+
+//! URLs use special chacters 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 delibarately does not provide many different sets.
+//! Users should consider in what context the encoded string will be used,
+//! real 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");
+//! ```
+
+use std::borrow::Cow;
+use std::fmt;
+use std::slice;
+use std::str;
+
+/// Represents a set of characters or bytes in the ASCII range.
+///
+/// This used in [`percent_encode`] and [`utf8_percent_encode`].
+/// This is simlar 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'`');
+/// ```
+pub struct AsciiSet {
+ mask: [Chunk; ASCII_RANGE_LEN / BITS_PER_CHUNK],
+}
+
+type Chunk = u32;
+
+const ASCII_RANGE_LEN: usize = 0x80;
+
+const BITS_PER_CHUNK: usize = 8 * std::mem::size_of::<Chunk>();
+
+impl AsciiSet {
+ /// Called with UTF-8 bytes rather than code points.
+ /// Not used for non-ASCII bytes.
+ const fn contains(&self, byte: u8) -> bool {
+ let chunk = self.mask[byte as usize / BITS_PER_CHUNK];
+ let mask = 1 << (byte as usize % BITS_PER_CHUNK);
+ (chunk & mask) != 0
+ }
+
+ fn should_percent_encode(&self, byte: u8) -> bool {
+ !byte.is_ascii() || self.contains(byte)
+ }
+
+ pub const fn add(&self, byte: u8) -> Self {
+ let mut mask = self.mask;
+ mask[byte as usize / BITS_PER_CHUNK] |= 1 << (byte as usize % BITS_PER_CHUNK);
+ AsciiSet { mask }
+ }
+
+ pub const fn remove(&self, byte: u8) -> Self {
+ let mut mask = self.mask;
+ mask[byte as usize / BITS_PER_CHUNK] &= !(1 << (byte as usize % BITS_PER_CHUNK));
+ AsciiSet { mask }
+ }
+}
+
+/// 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>
+pub const CONTROLS: &AsciiSet = &AsciiSet {
+ mask: [
+ !0_u32, // C0: 0x00 to 0x1F (32 bits set)
+ 0,
+ 0,
+ 1 << (0x7F_u32 % 32), // DEL: 0x7F (one bit set)
+ ],
+};
+
+macro_rules! static_assert {
+ ($( $bool: expr, )+) => {
+ fn _static_assert() {
+ $(
+ let _ = std::mem::transmute::<[u8; $bool as usize], u8>;
+ )+
+ }
+ }
+}
+
+static_assert! {
+ CONTROLS.contains(0x00),
+ CONTROLS.contains(0x1F),
+ !CONTROLS.contains(0x20),
+ !CONTROLS.contains(0x7E),
+ CONTROLS.contains(0x7F),
+}
+
+/// Everything that is not an ASCII letter or digit.
+///
+/// This is probably more eager than necessary in any context.
+pub const NON_ALPHANUMERIC: &AsciiSet = &CONTROLS
+ .add(b' ')
+ .add(b'!')
+ .add(b'"')
+ .add(b'#')
+ .add(b'$')
+ .add(b'%')
+ .add(b'&')
+ .add(b'\'')
+ .add(b'(')
+ .add(b')')
+ .add(b'*')
+ .add(b'+')
+ .add(b',')
+ .add(b'-')
+ .add(b'.')
+ .add(b'/')
+ .add(b':')
+ .add(b';')
+ .add(b'<')
+ .add(b'=')
+ .add(b'>')
+ .add(b'?')
+ .add(b'@')
+ .add(b'[')
+ .add(b'\\')
+ .add(b']')
+ .add(b'^')
+ .add(b'_')
+ .add(b'`')
+ .add(b'{')
+ .add(b'|')
+ .add(b'}')
+ .add(b'~');
+
+/// 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");
+/// ```
+pub fn percent_encode_byte(byte: u8) -> &'static str {
+ let index = usize::from(byte) * 3;
+ &"\
+ %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\
+ "[index..index + 3]
+}
+
+/// 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");
+/// ```
+#[inline]
+pub fn percent_encode<'a>(input: &'a [u8], ascii_set: &'static AsciiSet) -> PercentEncode<'a> {
+ PercentEncode {
+ bytes: input,
+ ascii_set,
+ }
+}
+
+/// 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");
+/// ```
+#[inline]
+pub fn utf8_percent_encode<'a>(input: &'a str, ascii_set: &'static AsciiSet) -> PercentEncode<'a> {
+ percent_encode(input.as_bytes(), ascii_set)
+}
+
+/// The return type of [`percent_encode`] and [`utf8_percent_encode`].
+#[derive(Clone)]
+pub struct PercentEncode<'a> {
+ bytes: &'a [u8],
+ ascii_set: &'static AsciiSet,
+}
+
+impl<'a> Iterator for PercentEncode<'a> {
+ type Item = &'a str;
+
+ fn next(&mut self) -> Option<&'a str> {
+ if let Some((&first_byte, remaining)) = self.bytes.split_first() {
+ if self.ascii_set.should_percent_encode(first_byte) {
+ self.bytes = remaining;
+ Some(percent_encode_byte(first_byte))
+ } else {
+ for (i, &byte) in remaining.iter().enumerate() {
+ if self.ascii_set.should_percent_encode(byte) {
+ // 1 for first_byte + i for previous iterations of this loop
+ let (unchanged_slice, remaining) = self.bytes.split_at(1 + i);
+ self.bytes = remaining;
+ return Some(unsafe { str::from_utf8_unchecked(unchanged_slice) });
+ }
+ }
+ let unchanged_slice = self.bytes;
+ self.bytes = &[][..];
+ Some(unsafe { str::from_utf8_unchecked(unchanged_slice) })
+ }
+ } else {
+ None
+ }
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ if self.bytes.is_empty() {
+ (0, Some(0))
+ } else {
+ (1, Some(self.bytes.len()))
+ }
+ }
+}
+
+impl<'a> fmt::Display for PercentEncode<'a> {
+ fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
+ for c in (*self).clone() {
+ formatter.write_str(c)?
+ }
+ Ok(())
+ }
+}
+
+impl<'a> From<PercentEncode<'a>> for Cow<'a, str> {
+ fn from(mut iter: PercentEncode<'a>) -> Self {
+ match iter.next() {
+ None => "".into(),
+ Some(first) => match iter.next() {
+ None => first.into(),
+ Some(second) => {
+ let mut string = first.to_owned();
+ string.push_str(second);
+ string.extend(iter);
+ string.into()
+ }
+ },
+ }
+ }
+}
+
+/// Percent-decode the given string.
+///
+/// <https://url.spec.whatwg.org/#string-percent-decode>
+///
+/// See [`percent_decode`] regarding the return type.
+#[inline]
+pub fn percent_decode_str(input: &str) -> PercentDecode {
+ percent_decode(input.as_bytes())
+}
+
+/// 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?");
+/// ```
+#[inline]
+pub fn percent_decode(input: &[u8]) -> PercentDecode {
+ PercentDecode {
+ bytes: input.iter(),
+ }
+}
+
+/// The return type of [`percent_decode`].
+#[derive(Clone, Debug)]
+pub struct PercentDecode<'a> {
+ bytes: slice::Iter<'a, u8>,
+}
+
+fn after_percent_sign(iter: &mut slice::Iter<u8>) -> Option<u8> {
+ let mut cloned_iter = iter.clone();
+ let h = char::from(*cloned_iter.next()?).to_digit(16)?;
+ let l = char::from(*cloned_iter.next()?).to_digit(16)?;
+ *iter = cloned_iter;
+ Some(h as u8 * 0x10 + l as u8)
+}
+
+impl<'a> Iterator for PercentDecode<'a> {
+ type Item = u8;
+
+ fn next(&mut self) -> Option<u8> {
+ self.bytes.next().map(|&byte| {
+ if byte == b'%' {
+ after_percent_sign(&mut self.bytes).unwrap_or(byte)
+ } else {
+ byte
+ }
+ })
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let bytes = self.bytes.len();
+ (bytes / 3, Some(bytes))
+ }
+}
+
+impl<'a> From<PercentDecode<'a>> for Cow<'a, [u8]> {
+ fn from(iter: PercentDecode<'a>) -> Self {
+ match iter.if_any() {
+ Some(vec) => Cow::Owned(vec),
+ None => Cow::Borrowed(iter.bytes.as_slice()),
+ }
+ }
+}
+
+impl<'a> PercentDecode<'a> {
+ /// If the percent-decoding is different from the input, return it as a new bytes vector.
+ fn if_any(&self) -> Option<Vec<u8>> {
+ let mut bytes_iter = self.bytes.clone();
+ while bytes_iter.any(|&b| b == b'%') {
+ if let Some(decoded_byte) = after_percent_sign(&mut bytes_iter) {
+ let initial_bytes = self.bytes.as_slice();
+ let unchanged_bytes_len = initial_bytes.len() - bytes_iter.len() - 3;
+ let mut decoded = initial_bytes[..unchanged_bytes_len].to_owned();
+ decoded.push(decoded_byte);
+ decoded.extend(PercentDecode { bytes: bytes_iter });
+ return Some(decoded);
+ }
+ }
+ // Nothing to decode
+ None
+ }
+
+ /// 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.
+ pub fn decode_utf8(self) -> Result<Cow<'a, str>, str::Utf8Error> {
+ match self.clone().into() {
+ Cow::Borrowed(bytes) => match str::from_utf8(bytes) {
+ Ok(s) => Ok(s.into()),
+ Err(e) => Err(e),
+ },
+ Cow::Owned(bytes) => match String::from_utf8(bytes) {
+ Ok(s) => Ok(s.into()),
+ Err(e) => Err(e.utf8_error()),
+ },
+ }
+ }
+
+ /// 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.
+ pub fn decode_utf8_lossy(self) -> Cow<'a, str> {
+ decode_utf8_lossy(self.clone().into())
+ }
+}
+
+fn decode_utf8_lossy(input: Cow<[u8]>) -> Cow<str> {
+ match input {
+ Cow::Borrowed(bytes) => String::from_utf8_lossy(bytes),
+ Cow::Owned(bytes) => {
+ let raw_utf8: *const [u8];
+ match String::from_utf8_lossy(&bytes) {
+ Cow::Borrowed(utf8) => raw_utf8 = utf8.as_bytes(),
+ Cow::Owned(s) => return s.into(),
+ }
+ // from_utf8_lossy returned a borrow of `bytes` unchanged.
+ debug_assert!(raw_utf8 == &*bytes as *const [u8]);
+ // Reuse the existing `Vec` allocation.
+ unsafe { String::from_utf8_unchecked(bytes) }.into()
+ }
+ }
+}