|
|
<!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="API documentation for the Rust `percent_encode` fn in crate `percent_encoding`."><meta name="keywords" content="rust, rustlang, rust-lang, percent_encode"><title>percent_encoding::percent_encode - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../percent_encoding/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>percent_encoding</a></p><script>window.sidebarCurrent = {name: 'percent_encode', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/percent_encoding/lib.rs.html#213-218' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>percent_encoding</a>::<wbr><a class="fn" href=''>percent_encode</a></span></h1><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../percent_encoding/struct.PercentEncode.html" title="struct percent_encoding::PercentEncode">PercentEncode</a><'a, E></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../percent_encoding/struct.PercentEncode.html" title="struct percent_encoding::PercentEncode">PercentEncode</a><'a, E></h3><code class="content"><span class="where fmt-newline">impl<'a, E: <a class="trait" href="../percent_encoding/trait.EncodeSet.html" title="trait percent_encoding::EncodeSet">EncodeSet</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../percent_encoding/struct.PercentEncode.html" title="struct percent_encoding::PercentEncode">PercentEncode</a><'a, E></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;</span></code></div></div><pre class='rust fn'>pub fn percent_encode<E: <a class="trait" href="../percent_encoding/trait.EncodeSet.html" title="trait percent_encoding::EncodeSet">EncodeSet</a>>(<br> input: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> encode_set: E<br>) -> <a class="struct" href="../percent_encoding/struct.PercentEncode.html" title="struct percent_encoding::PercentEncode">PercentEncode</a><E></pre><div class='docblock'><p>Percent-encode the given bytes with the given encode set.</p>
|
|
|
<p>The encode set define which bytes (in addition to non-ASCII and controls)
|
|
|
need to be percent-encoded.
|
|
|
The choice of this set depends on context.
|
|
|
For example, <code>?</code> needs to be encoded in an URL path but not in a query string.</p>
|
|
|
<p>The return value is an iterator of <code>&str</code> slices (so it has a <code>.collect::<String>()</code> method)
|
|
|
that also implements <code>Display</code> and <code>Into<Cow<str>></code>.
|
|
|
The latter returns <code>Cow::Borrowed</code> when none of the bytes in <code>input</code>
|
|
|
are in the given encode set.</p>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">url</span>::<span class="ident">percent_encoding</span>::{<span class="ident">percent_encode</span>, <span class="ident">DEFAULT_ENCODE_SET</span>};
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">percent_encode</span>(<span class="string">b"foo bar?"</span>, <span class="ident">DEFAULT_ENCODE_SET</span>).<span class="ident">to_string</span>(), <span class="string">"foo%20bar%3F"</span>);</pre></div>
|
|
|
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "percent_encoding";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
