blob: 59a590d3fc758039e5a9b0cd24ac1d5d08b57b95 [file] [log] [blame]
<!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 `U16UtfExt` trait in crate `encode_unicode`.">
<meta name="keywords" content="rust, rustlang, rust-lang, U16UtfExt">
<title>encode_unicode::U16UtfExt - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<p class='location'>Trait U16UtfExt</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='index.html'>encode_unicode</a></p><script>window.sidebarCurrent = {name: 'U16UtfExt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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'>encode_unicode</a>::<wbr><a class="trait" href=''>U16UtfExt</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/encode_unicode/traits.rs.html#54-65' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait U16UtfExt {
fn <a href='#tymethod.utf16_needs_extra_unit' class='fnname'>utf16_needs_extra_unit</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.utf16_is_leading_surrogate' class='fnname'>utf16_is_leading_surrogate</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
}</pre><div class='docblock'><p>Methods for working with <code>u16</code>s as UTF-16 units.</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.utf16_needs_extra_unit' class='method'><span id='utf16_needs_extra_unit.v' class='invisible'><code>fn <a href='#tymethod.utf16_needs_extra_unit' class='fnname'>utf16_needs_extra_unit</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;</code></span></h3><div class='docblock'><p>Will you need an extra unit to complete this codepoint?</p>
<h1 id='failures' class='section-header'><a href='#failures'>Failures:</a></h1>
<p>0xdc00..0xe000</p>
</div><h3 id='tymethod.utf16_is_leading_surrogate' class='method'><span id='utf16_is_leading_surrogate.v' class='invisible'><code>fn <a href='#tymethod.utf16_is_leading_surrogate' class='fnname'>utf16_is_leading_surrogate</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Does this <code>u16</code> need another <code>u16</code> to complete a codepoint?
Returns <code>(self &amp; 0xfc00) == 0xd800</code></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><code>impl U16UtfExt for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></li>
</ul><script type="text/javascript" async
src="../implementors/encode_unicode/trait.U16UtfExt.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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "encode_unicode";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>