158 lines
8.7 KiB
HTML
158 lines
8.7 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="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="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
<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">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>percent_encoding</a>::<wbr><a class="trait" href=''>EncodeSet</a></span><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></h1>
|
|||
|
|
<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 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'><span id='contains.v' class='invisible'><code>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></span></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>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/percent_encoding/lib.rs.html#112-117' title='goto source code'>[src]</a></div><code>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></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></div><code>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></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></div><code>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></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></div><code>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></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/percent_encoding/lib.rs.html#90-100' title='goto source code'>[src]</a></div><code>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></li>
|
|||
|
|
</ul><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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "percent_encoding";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|