|
|
<!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 `EncodeSet` trait in crate `percent_encoding`."><meta name="keywords" content="rust, rustlang, rust-lang, EncodeSet"><title>percent_encoding::EncodeSet - 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 trait"><!--[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><p class='location'>Trait EncodeSet</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.contains">contains</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>percent_encoding</a></p><script>window.sidebarCurrent = {name: 'EncodeSet', ty: 'trait', 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#54-58' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>percent_encoding</a>::<wbr><a class="trait" href=''>EncodeSet</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait EncodeSet: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> {
|
|
|
fn <a href='#tymethod.contains' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a>;
|
|
|
}</pre></div><div class='docblock'><p>Represents a set of characters / bytes that should be percent-encoded.</p>
|
|
|
<p>See <a href="http://url.spec.whatwg.org/#simple-encode-set">encode sets specification</a>.</p>
|
|
|
<p>Different characters need to be encoded in different parts of an URL.
|
|
|
For example, a literal <code>?</code> question mark in an URL’s path would indicate
|
|
|
the start of the query string.
|
|
|
A question mark meant to be part of the path therefore needs to be percent-encoded.
|
|
|
In the query string however, a question mark does not have any special meaning
|
|
|
and does not need to be percent-encoded.</p>
|
|
|
<p>A few sets are defined in this module.
|
|
|
Use the <a href="../macro.define_encode_set!.html"><code>define_encode_set!</code></a> macro to define different ones.</p>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.contains' class='method'><code id='contains.v'>fn <a href='#tymethod.contains' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code></h3><div class='docblock'><p>Called with UTF-8 bytes rather than code points.
|
|
|
Should return true for all non-ASCII bytes.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-EncodeSet' class='impl'><code class='in-band'>impl EncodeSet for <a class="struct" href="../percent_encoding/struct.DEFAULT_ENCODE_SET.html" title="struct percent_encoding::DEFAULT_ENCODE_SET">DEFAULT_ENCODE_SET</a></code><a href='#impl-EncodeSet' class='anchor'></a><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.contains' class="method hidden"><code id='contains.v-1'>fn <a href='#method.contains' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code><a class='srclink' href='../src/percent_encoding/lib.rs.html#92-99' title='goto source code'>[src]</a></h4></div><h3 id='impl-EncodeSet-1' class='impl'><code class='in-band'>impl EncodeSet for <a class="struct" href="../percent_encoding/struct.PATH_SEGMENT_ENCODE_SET.html" title="struct percent_encoding::PATH_SEGMENT_ENCODE_SET">PATH_SEGMENT_ENCODE_SET</a></code><a href='#impl-EncodeSet-1' class='anchor'></a><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.contains-1' class="method hidden"><code id='contains.v-2'>fn <a href='#method.contains-1' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code><a class='srclink' href='../src/percent_encoding/lib.rs.html#92-99' title='goto source code'>[src]</a></h4></div><h3 id='impl-EncodeSet-2' class='impl'><code class='in-band'>impl EncodeSet for <a class="struct" href="../percent_encoding/struct.QUERY_ENCODE_SET.html" title="struct percent_encoding::QUERY_ENCODE_SET">QUERY_ENCODE_SET</a></code><a href='#impl-EncodeSet-2' class='anchor'></a><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.contains-2' class="method hidden"><code id='contains.v-3'>fn <a href='#method.contains-2' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code><a class='srclink' href='../src/percent_encoding/lib.rs.html#92-99' title='goto source code'>[src]</a></h4></div><h3 id='impl-EncodeSet-3' class='impl'><code class='in-band'>impl EncodeSet for <a class="struct" href="../percent_encoding/struct.SIMPLE_ENCODE_SET.html" title="struct percent_encoding::SIMPLE_ENCODE_SET">SIMPLE_ENCODE_SET</a></code><a href='#impl-EncodeSet-3' class='anchor'></a><a class='srclink' href='../src/percent_encoding/lib.rs.html#112-117' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.contains-3' class="method hidden"><code id='contains.v-4'>fn <a href='#method.contains-3' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code><a class='srclink' href='../src/percent_encoding/lib.rs.html#114-116' title='goto source code'>[src]</a></h4></div><h3 id='impl-EncodeSet-4' class='impl'><code class='in-band'>impl EncodeSet for <a class="struct" href="../percent_encoding/struct.USERINFO_ENCODE_SET.html" title="struct percent_encoding::USERINFO_ENCODE_SET">USERINFO_ENCODE_SET</a></code><a href='#impl-EncodeSet-4' class='anchor'></a><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.contains-4' class="method hidden"><code id='contains.v-5'>fn <a href='#method.contains-4' class='fnname'>contains</a>(&self, byte: <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.bool.html">bool</a></code><a class='srclink' href='../src/percent_encoding/lib.rs.html#92-99' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
src="../implementors/percent_encoding/trait.EncodeSet.js">
|
|
|
</script></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> |
