<!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 `decode_utf16` fn in crate `std_unicode`.">
<meta name="keywords" content="rust, rustlang, rust-lang, decode_utf16">
<title>std_unicode::char::decode_utf16 - 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>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</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='../../std_unicode/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'><a href='../index.html'>std_unicode</a>::<wbr><a href='index.html'>char</a></p><script>window.sidebarCurrent = {name: 'decode_utf16', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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'>Function <a href='../index.html'>std_unicode</a>::<wbr><a href='index.html'>char</a>::<wbr><a class="fn" href=''>decode_utf16</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.9.0'>1.9.0</span><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/std_unicode/char.rs.html#1519-1524' title='goto source code'>[src]</a></span></h1>
<div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../std_unicode/char/struct.DecodeUtf16.html" title="struct std_unicode::char::DecodeUtf16">DecodeUtf16</a><I></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../std_unicode/char/struct.DecodeUtf16.html" title="struct std_unicode::char::DecodeUtf16">DecodeUtf16</a><I></h3><code class="content"><span class="where fmt-newline">impl<I: <a class="trait" href="../../core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a><Item = u16>> <a class="trait" href="../../core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../std_unicode/char/struct.DecodeUtf16.html" title="struct std_unicode::char::DecodeUtf16">DecodeUtf16</a><I></span><span class="where fmt-newline"> type <a href='../../core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a><char, <a class="struct" href="../../std_unicode/char/struct.DecodeUtf16Error.html" title="struct std_unicode::char::DecodeUtf16Error">DecodeUtf16Error</a>>;</span></code></div></div><pre class='rust fn'>pub fn decode_utf16<I: <a class="trait" href="../../core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = u16>>(<br> iter: I<br>) -> <a class="struct" href="../../std_unicode/char/struct.DecodeUtf16.html" title="struct std_unicode::char::DecodeUtf16">DecodeUtf16</a><I::<a class="type" href="../../core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a>></pre><div class='docblock'><p>Create an iterator over the UTF-16 encoded code points in <code>iter</code>,
returning unpaired surrogates as <code>Err</code>s.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>Basic usage:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">char</span>::<span class="ident">decode_utf16</span>;
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// 𝄞mus<invalid>ic<invalid></span>
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> [<span class="number">0xD834</span>, <span class="number">0xDD1E</span>, <span class="number">0x006d</span>, <span class="number">0x0075</span>,
<span class="number">0x0073</span>, <span class="number">0xDD1E</span>, <span class="number">0x0069</span>, <span class="number">0x0063</span>,
<span class="number">0xD834</span>];
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">decode_utf16</span>(<span class="ident">v</span>.<span class="ident">iter</span>().<span class="ident">cloned</span>())
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">e</span>.<span class="ident">unpaired_surrogate</span>()))
.<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span>_<span class="op">>></span>(),
<span class="macro">vec</span><span class="macro">!</span>[<span class="prelude-val">Ok</span>(<span class="string">'𝄞'</span>),
<span class="prelude-val">Ok</span>(<span class="string">'m'</span>), <span class="prelude-val">Ok</span>(<span class="string">'u'</span>), <span class="prelude-val">Ok</span>(<span class="string">'s'</span>),
<span class="prelude-val">Err</span>(<span class="number">0xDD1E</span>),
<span class="prelude-val">Ok</span>(<span class="string">'i'</span>), <span class="prelude-val">Ok</span>(<span class="string">'c'</span>),
<span class="prelude-val">Err</span>(<span class="number">0xD834</span>)]);
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Ause%20std%3A%3Achar%3A%3Adecode_utf16%3B%0A%0Afn%20main()%20%7B%0A%20%20%20%20%2F%2F%20%F0%9D%84%9Emus%3Cinvalid%3Eic%3Cinvalid%3E%0A%20%20%20%20let%20v%20%3D%20%5B0xD834%2C%200xDD1E%2C%200x006d%2C%200x0075%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%200x0073%2C%200xDD1E%2C%200x0069%2C%200x0063%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%200xD834%5D%3B%0A%0A%20%20%20%20assert_eq!(decode_utf16(v.iter().cloned())%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20.map(%7Cr%7C%20r.map_err(%7Ce%7C%20e.unpaired_surrogate()))%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20.collect%3A%3A%3CVec%3C_%3E%3E()%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20vec!%5BOk('%F0%9D%84%9E')%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ok('m')%2C%20Ok('u')%2C%20Ok('s')%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Err(0xDD1E)%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ok('i')%2C%20Ok('c')%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Err(0xD834)%5D)%3B%0A%7D%0A">Run</a></pre>
<p>A lossy decoder can be obtained by replacing <code>Err</code> results with the replacement character:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">char</span>::{<span class="ident">decode_utf16</span>, <span class="ident">REPLACEMENT_CHARACTER</span>};
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// 𝄞mus<invalid>ic<invalid></span>
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> [<span class="number">0xD834</span>, <span class="number">0xDD1E</span>, <span class="number">0x006d</span>, <span class="number">0x0075</span>,
<span class="number">0x0073</span>, <span class="number">0xDD1E</span>, <span class="number">0x0069</span>, <span class="number">0x0063</span>,
<span class="number">0xD834</span>];
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">decode_utf16</span>(<span class="ident">v</span>.<span class="ident">iter</span>().<span class="ident">cloned</span>())
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">unwrap_or</span>(<span class="ident">REPLACEMENT_CHARACTER</span>))
.<span class="ident">collect</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(),
<span class="string">"𝄞mus�ic�"</span>);
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Ause%20std%3A%3Achar%3A%3A%7Bdecode_utf16%2C%20REPLACEMENT_CHARACTER%7D%3B%0A%0Afn%20main()%20%7B%0A%20%20%20%20%2F%2F%20%F0%9D%84%9Emus%3Cinvalid%3Eic%3Cinvalid%3E%0A%20%20%20%20let%20v%20%3D%20%5B0xD834%2C%200xDD1E%2C%200x006d%2C%200x0075%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%200x0073%2C%200xDD1E%2C%200x0069%2C%200x0063%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%200xD834%5D%3B%0A%0A%20%20%20%20assert_eq!(decode_utf16(v.iter().cloned())%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20.map(%7Cr%7C%20r.unwrap_or(REPLACEMENT_CHARACTER))%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20.collect%3A%3A%3CString%3E()%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22%F0%9D%84%9Emus%EF%BF%BDic%EF%BF%BD%22)%3B%0A%7D%0A">Run</a></pre>
</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "std_unicode";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
6218
