Files
GopherGate/target/doc/percent_encoding/fn.percent_encode.html
2026-02-26 12:00:21 -05:00

15 lines
5.5 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="Percent-encode the given bytes with the given set."><title>percent_encode in percent_encoding - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="percent_encoding" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></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]--><rustdoc-topbar><h2><a href="#">percent_encode</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../percent_encoding/index.html">percent_<wbr>encoding</a><span class="version">2.3.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">percent_<wbr>encode</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate percent_<wbr>encoding</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">percent_encoding</a></div><h1>Function <span class="fn">percent_<wbr>encode</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/percent_encoding/lib.rs.html#117-122">Source</a> </span></div><pre class="rust item-decl"><code>pub fn percent_encode&lt;'a&gt;(
input: &amp;'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
ascii_set: &amp;'static <a class="struct" href="struct.AsciiSet.html" title="struct percent_encoding::AsciiSet">AsciiSet</a>,
) -&gt; <a class="struct" href="struct.PercentEncode.html" title="struct percent_encoding::PercentEncode">PercentEncode</a>&lt;'a&gt; <a href="#" class="tooltip" data-notable-ty="PercentEncode&lt;&#39;a&gt;"></a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Percent-encode the given bytes with the given set.</p>
<p>Non-ASCII bytes and bytes in <code>ascii_set</code> are encoded.</p>
<p>The return type:</p>
<ul>
<li>Implements <code>Iterator&lt;Item = &amp;str&gt;</code> and therefore has a <code>.collect::&lt;String&gt;()</code> method,</li>
<li>Implements <code>Display</code> and therefore has a <code>.to_string()</code> method,</li>
<li>Implements <code>Into&lt;Cow&lt;str&gt;&gt;</code> borrowing <code>input</code> when none of its bytes are encoded.</li>
</ul>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>percent_encoding::{percent_encode, NON_ALPHANUMERIC};
<span class="macro">assert_eq!</span>(percent_encode(<span class="string">b"foo bar?"</span>, NON_ALPHANUMERIC).to_string(), <span class="string">"foo%20bar%3F"</span>);</code></pre></div></div></details><script type="text/json" id="notable-traits-data">{"PercentEncode<'a>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.PercentEncode.html\" title=\"struct percent_encoding::PercentEncode\">PercentEncode</a>&lt;'a&gt;</code></h3><pre><code><div class=\"where\">impl&lt;'a&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.PercentEncode.html\" title=\"struct percent_encoding::PercentEncode\">PercentEncode</a>&lt;'a&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = &amp;'a <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.93.1/std/primitive.str.html\">str</a>;</div>"}</script></section></div></main></body></html>