<!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="Source to the Rust file `libstd/sys/windows/ext/ffi.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>ffi.rs.html -- source</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 source">
<!--[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/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2015 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">//! Windows-specific extensions to the primitives in the `std::ffi` module.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Overview</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For historical reasons, the Windows API uses a form of potentially</span>
<span class="doccomment">//! ill-formed UTF-16 encoding for strings. Specifically, the 16-bit</span>
<span class="doccomment">//! code units in Windows strings may contain [isolated surrogate code</span>
<span class="doccomment">//! points which are not paired together][ill-formed-utf-16]. The</span>
<span class="doccomment">//! Unicode standard requires that surrogate code points (those in the</span>
<span class="doccomment">//! range U+D800 to U+DFFF) always be *paired*, because in the UTF-16</span>
<span class="doccomment">//! encoding a *surrogate code unit pair* is used to encode a single</span>
<span class="doccomment">//! character. For compatibility with code that does not enforce</span>
<span class="doccomment">//! these pairings, Windows does not enforce them, either.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! While it is not always possible to convert such a string losslessly into</span>
<span class="doccomment">//! a valid UTF-16 string (or even UTF-8), it is often desirable to be</span>
<span class="doccomment">//! able to round-trip such a string from and to Windows APIs</span>
<span class="doccomment">//! losslessly. For example, some Rust code may be "bridging" some</span>
<span class="doccomment">//! Windows APIs together, just passing `WCHAR` strings among those</span>
<span class="doccomment">//! APIs without ever really looking into the strings.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! If Rust code *does* need to look into those strings, it can</span>
<span class="doccomment">//! convert them to valid UTF-8, possibly lossily, by substituting</span>
<span class="doccomment">//! invalid sequences with U+FFFD REPLACEMENT CHARACTER, as is</span>
<span class="doccomment">//! conventionally done in other Rust APIs that deal with string</span>
<span class="doccomment">//! encodings.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # `OsStringExt` and `OsStrExt`</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`OsString`] is the Rust wrapper for owned strings in the</span>
<span class="doccomment">//! preferred representation of the operating system. On Windows,</span>
<span class="doccomment">//! this struct gets augmented with an implementation of the</span>
<span class="doccomment">//! [`OsStringExt`] trait, which has a [`from_wide`] method. This</span>
<span class="doccomment">//! lets you create an [`OsString`] from a `&[u16]` slice; presumably</span>
<span class="doccomment">//! you get such a slice out of a `WCHAR` Windows API.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Similarly, [`OsStr`] is the Rust wrapper for borrowed strings from</span>
<span class="doccomment">//! preferred representation of the operating system. On Windows, the</span>
<span class="doccomment">//! [`OsStrExt`] trait provides the [`encode_wide`] method, which</span>
<span class="doccomment">//! outputs an [`EncodeWide`] iterator. You can [`collect`] this</span>
<span class="doccomment">//! iterator, for example, to obtain a `Vec<u16>`; you can later get a</span>
<span class="doccomment">//! pointer to this vector's contents and feed it to Windows APIs.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! These traits, along with [`OsString`] and [`OsStr`], work in</span>
<span class="doccomment">//! conjunction so that it is possible to **round-trip** strings from</span>
<span class="doccomment">//! Windows and back, with no loss of data, even if the strings are</span>
<span class="doccomment">//! ill-formed UTF-16.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [ill-formed-utf-16]: https://simonsapin.github.io/wtf-8/#ill-formed-utf-16</span>
<span class="doccomment">//! [`OsString`]: ../../../ffi/struct.OsString.html</span>
<span class="doccomment">//! [`OsStr`]: ../../../ffi/struct.OsStr.html</span>
<span class="doccomment">//! [`OsStringExt`]: trait.OsStringExt.html</span>
<span class="doccomment">//! [`OsStrExt`]: trait.OsStrExt.html</span>
<span class="doccomment">//! [`EncodeWide`]: struct.EncodeWide.html</span>
<span class="doccomment">//! [`from_wide`]: trait.OsStringExt.html#tymethod.from_wide</span>
<span class="doccomment">//! [`encode_wide`]: trait.OsStrExt.html#tymethod.encode_wide</span>
<span class="doccomment">//! [`collect`]: ../../../iter/trait.Iterator.html#method.collect</span>
<span class="attribute">#![<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">use</span> <span class="ident">ffi</span>::{<span class="ident">OsString</span>, <span class="ident">OsStr</span>};
<span class="kw">use</span> <span class="ident">sys</span>::<span class="ident">os_str</span>::<span class="ident">Buf</span>;
<span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">wtf8</span>::<span class="ident">Wtf8Buf</span>;
<span class="kw">use</span> <span class="ident">sys_common</span>::{<span class="ident">FromInner</span>, <span class="ident">AsInner</span>};
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">wtf8</span>::<span class="ident">EncodeWide</span>;
<span class="doccomment">/// Windows-specific extensions to `OsString`.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">OsStringExt</span> {
<span class="doccomment">/// Creates an `OsString` from a potentially ill-formed UTF-16 slice of</span>
<span class="doccomment">/// 16-bit code units.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is lossless: calling [`encode_wide`] on the resulting string</span>
<span class="doccomment">/// will always return the original code units.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::OsString;</span>
<span class="doccomment">/// use std::os::windows::prelude::*;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // UTF-16 encoding for "Unicode".</span>
<span class="doccomment">/// let source = [0x0055, 0x006E, 0x0069, 0x0063, 0x006F, 0x0064, 0x0065];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let string = OsString::from_wide(&source[..]);</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`encode_wide`]: ./trait.OsStrExt.html#tymethod.encode_wide</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">fn</span> <span class="ident">from_wide</span>(<span class="ident">wide</span>: <span class="kw-2">&</span>[<span class="ident">u16</span>]) <span class="op">-></span> <span class="self">Self</span>;
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">OsStringExt</span> <span class="kw">for</span> <span class="ident">OsString</span> {
<span class="kw">fn</span> <span class="ident">from_wide</span>(<span class="ident">wide</span>: <span class="kw-2">&</span>[<span class="ident">u16</span>]) <span class="op">-></span> <span class="ident">OsString</span> {
<span class="ident">FromInner</span>::<span class="ident">from_inner</span>(<span class="ident">Buf</span> { <span class="ident">inner</span>: <span class="ident">Wtf8Buf</span>::<span class="ident">from_wide</span>(<span class="ident">wide</span>) })
}
}
<span class="doccomment">/// Windows-specific extensions to `OsStr`.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">OsStrExt</span> {
<span class="doccomment">/// Re-encodes an `OsStr` as a wide character sequence, i.e. potentially</span>
<span class="doccomment">/// ill-formed UTF-16.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is lossless: calling [`OsString::from_wide`] and then</span>
<span class="doccomment">/// `encode_wide` on the result will yield the original code units.</span>
<span class="doccomment">/// Note that the encoding does not add a final null terminator.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::OsString;</span>
<span class="doccomment">/// use std::os::windows::prelude::*;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // UTF-16 encoding for "Unicode".</span>
<span class="doccomment">/// let source = [0x0055, 0x006E, 0x0069, 0x0063, 0x006F, 0x0064, 0x0065];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let string = OsString::from_wide(&source[..]);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let result: Vec<u16> = string.encode_wide().collect();</span>
<span class="doccomment">/// assert_eq!(&source[..], &result[..]);</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`OsString::from_wide`]: ./trait.OsStringExt.html#tymethod.from_wide</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">fn</span> <span class="ident">encode_wide</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">EncodeWide</span>;
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">OsStrExt</span> <span class="kw">for</span> <span class="ident">OsStr</span> {
<span class="kw">fn</span> <span class="ident">encode_wide</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">EncodeWide</span> {
<span class="self">self</span>.<span class="ident">as_inner</span>().<span class="ident">inner</span>.<span class="ident">encode_wide</span>()
}
}
</pre>
</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";
</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
>
3402
