| <!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 of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/osstringext.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>osstringext.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../clap/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::ffi::OsStr; |
| <span class="attribute">#[cfg(not(any(target_os = <span class="string">"windows"</span>, target_arch = <span class="string">"wasm32"</span>)))] |
| </span><span class="kw">use </span>std::os::unix::ffi::OsStrExt; |
| <span class="attribute">#[cfg(any(target_os = <span class="string">"windows"</span>, target_arch = <span class="string">"wasm32"</span>))] |
| </span><span class="kw">use </span><span class="kw">crate</span>::INVALID_UTF8; |
| |
| <span class="attribute">#[cfg(any(target_os = <span class="string">"windows"</span>, target_arch = <span class="string">"wasm32"</span>))] |
| </span><span class="kw">pub trait </span>OsStrExt3 { |
| <span class="kw">fn </span>from_bytes(b: <span class="kw-2">&</span>[u8]) -> <span class="kw-2">&</span><span class="self">Self</span>; |
| <span class="kw">fn </span>as_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8]; |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub trait </span>OsStrExt2 { |
| <span class="kw">fn </span>starts_with(<span class="kw-2">&</span><span class="self">self</span>, s: <span class="kw-2">&</span>[u8]) -> bool; |
| <span class="kw">fn </span>split_at_byte(<span class="kw-2">&</span><span class="self">self</span>, b: u8) -> (<span class="kw-2">&</span>OsStr, <span class="kw-2">&</span>OsStr); |
| <span class="kw">fn </span>split_at(<span class="kw-2">&</span><span class="self">self</span>, i: usize) -> (<span class="kw-2">&</span>OsStr, <span class="kw-2">&</span>OsStr); |
| <span class="kw">fn </span>trim_left_matches(<span class="kw-2">&</span><span class="self">self</span>, b: u8) -> <span class="kw-2">&</span>OsStr; |
| <span class="kw">fn </span>contains_byte(<span class="kw-2">&</span><span class="self">self</span>, b: u8) -> bool; |
| <span class="kw">fn </span>split(<span class="kw-2">&</span><span class="self">self</span>, b: u8) -> OsSplit; |
| } |
| |
| <span class="comment">// A starts-with implementation that does not panic when the OsStr contains |
| // invalid Unicode. |
| // |
| // A Windows OsStr is usually UTF-16. If `prefix` is valid UTF-8, we can |
| // re-encode it as UTF-16, and ask whether `osstr` starts with the same series |
| // of u16 code units. If `prefix` is not valid UTF-8, then this comparison |
| // isn't meaningful, and we just return false. |
| </span><span class="attribute">#[cfg(target_os = <span class="string">"windows"</span>)] |
| </span><span class="kw">fn </span>windows_osstr_starts_with(osstr: <span class="kw-2">&</span>OsStr, prefix: <span class="kw-2">&</span>[u8]) -> bool { |
| <span class="kw">use </span>std::os::windows::ffi::OsStrExt; |
| <span class="kw">let </span>prefix_str = <span class="kw">if let </span><span class="prelude-val">Ok</span>(s) = std::str::from_utf8(prefix) { |
| s |
| } <span class="kw">else </span>{ |
| <span class="kw">return </span><span class="bool-val">false</span>; |
| }; |
| <span class="kw">let </span><span class="kw-2">mut </span>osstr_units = osstr.encode_wide(); |
| <span class="kw">let </span><span class="kw-2">mut </span>prefix_units = prefix_str.encode_utf16(); |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span>(osstr_units.next(), prefix_units.next()) { |
| <span class="comment">// These code units match. Keep looping. |
| </span>(<span class="prelude-val">Some</span>(o), <span class="prelude-val">Some</span>(p)) <span class="kw">if </span>o == p => <span class="kw">continue</span>, |
| <span class="comment">// We've reached the end of the prefix. It's a match. |
| </span>(<span class="kw">_</span>, <span class="prelude-val">None</span>) => <span class="kw">return </span><span class="bool-val">true</span>, |
| <span class="comment">// Otherwise, it's not a match. |
| </span><span class="kw">_ </span>=> <span class="kw">return </span><span class="bool-val">false</span>, |
| } |
| } |
| } |
| |
| <span class="attribute">#[test] |
| #[cfg(target_os = <span class="string">"windows"</span>)] |
| </span><span class="kw">fn </span>test_windows_osstr_starts_with() { |
| <span class="kw">use </span>std::ffi::OsString; |
| <span class="kw">use </span>std::os::windows::ffi::OsStringExt; |
| |
| <span class="kw">fn </span>from_ascii(ascii: <span class="kw-2">&</span>[u8]) -> OsString { |
| <span class="kw">let </span>u16_vec: Vec<u16> = ascii.iter().map(|<span class="kw-2">&</span>c| c <span class="kw">as </span>u16).collect(); |
| OsString::from_wide(<span class="kw-2">&</span>u16_vec) |
| } |
| |
| <span class="comment">// Test all the basic cases. |
| </span><span class="macro">assert!</span>(windows_osstr_starts_with(<span class="kw-2">&</span>from_ascii(<span class="string">b"abcdef"</span>), <span class="string">b"abc"</span>)); |
| <span class="macro">assert!</span>(windows_osstr_starts_with(<span class="kw-2">&</span>from_ascii(<span class="string">b"abcdef"</span>), <span class="string">b"abcdef"</span>)); |
| <span class="macro">assert!</span>(!windows_osstr_starts_with(<span class="kw-2">&</span>from_ascii(<span class="string">b"abcdef"</span>), <span class="string">b"def"</span>)); |
| <span class="macro">assert!</span>(!windows_osstr_starts_with(<span class="kw-2">&</span>from_ascii(<span class="string">b"abc"</span>), <span class="string">b"abcd"</span>)); |
| |
| <span class="comment">// Test the case where the candidate prefix is not valid UTF-8. Note that a |
| // standalone \xff byte is valid ASCII but not valid UTF-8. Thus although |
| // these strings look identical, they do not match. |
| </span><span class="macro">assert!</span>(!windows_osstr_starts_with(<span class="kw-2">&</span>from_ascii(<span class="string">b"\xff"</span>), <span class="string">b"\xff"</span>)); |
| |
| <span class="comment">// Test the case where the OsString is not valid UTF-16. It should still be |
| // possible to match the valid characters at the front. |
| // |
| // UTF-16 surrogate characters are only valid in pairs. Including one on |
| // the end by itself makes this invalid UTF-16. |
| </span><span class="kw">let </span>surrogate_char: u16 = <span class="number">0xDC00</span>; |
| <span class="kw">let </span>invalid_unicode = |
| OsString::from_wide(<span class="kw-2">&</span>[<span class="string">'a' </span><span class="kw">as </span>u16, <span class="string">'b' </span><span class="kw">as </span>u16, <span class="string">'c' </span><span class="kw">as </span>u16, surrogate_char]); |
| <span class="macro">assert!</span>( |
| invalid_unicode.to_str().is_none(), |
| <span class="string">"This string is invalid Unicode, and conversion to &str should fail."</span>, |
| ); |
| <span class="macro">assert!</span>(windows_osstr_starts_with(<span class="kw-2">&</span>invalid_unicode, <span class="string">b"abc"</span>)); |
| <span class="macro">assert!</span>(!windows_osstr_starts_with(<span class="kw-2">&</span>invalid_unicode, <span class="string">b"abcd"</span>)); |
| } |
| |
| <span class="attribute">#[cfg(any(target_os = <span class="string">"windows"</span>, target_arch = <span class="string">"wasm32"</span>))] |
| </span><span class="kw">impl </span>OsStrExt3 <span class="kw">for </span>OsStr { |
| <span class="kw">fn </span>from_bytes(b: <span class="kw-2">&</span>[u8]) -> <span class="kw-2">&</span><span class="self">Self </span>{ |
| <span class="kw">use </span>std::mem; |
| <span class="kw">unsafe </span>{ mem::transmute(b) } |
| } |
| <span class="kw">fn </span>as_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.to_str().map(|s| s.as_bytes()).expect(INVALID_UTF8) |
| } |
| } |
| |
| <span class="kw">impl </span>OsStrExt2 <span class="kw">for </span>OsStr { |
| <span class="kw">fn </span>starts_with(<span class="kw-2">&</span><span class="self">self</span>, s: <span class="kw-2">&</span>[u8]) -> bool { |
| <span class="attribute">#[cfg(target_os = <span class="string">"windows"</span>)] |
| </span>{ |
| <span class="comment">// On Windows, the as_bytes() method will panic if the OsStr |
| // contains invalid Unicode. To avoid this, we use a |
| // Windows-specific starts-with function that doesn't rely on |
| // as_bytes(). This is necessary for Windows command line |
| // applications to handle non-Unicode arguments successfully. This |
| // allows common cases like `clap.exe [invalid]` to succeed, though |
| // cases that require string splitting will still fail, like |
| // `clap.exe --arg=[invalid]`. Note that this entire module is |
| // replaced in Clap 3.x, so this workaround is specific to the 2.x |
| // branch. |
| </span>windows_osstr_starts_with(<span class="self">self</span>, s) |
| } |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"windows"</span>))] |
| </span>{ |
| <span class="self">self</span>.as_bytes().starts_with(s) |
| } |
| } |
| |
| <span class="kw">fn </span>contains_byte(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> bool { |
| <span class="kw">for </span>b <span class="kw">in </span><span class="self">self</span>.as_bytes() { |
| <span class="kw">if </span>b == <span class="kw-2">&</span>byte { |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| } |
| <span class="bool-val">false |
| </span>} |
| |
| <span class="kw">fn </span>split_at_byte(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> (<span class="kw-2">&</span>OsStr, <span class="kw-2">&</span>OsStr) { |
| <span class="kw">for </span>(i, b) <span class="kw">in </span><span class="self">self</span>.as_bytes().iter().enumerate() { |
| <span class="kw">if </span>b == <span class="kw-2">&</span>byte { |
| <span class="kw">return </span>( |
| OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[..i]), |
| OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[i + <span class="number">1</span>..]), |
| ); |
| } |
| } |
| ( |
| <span class="kw-2">&*</span><span class="self">self</span>, |
| OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[<span class="self">self</span>.len()..<span class="self">self</span>.len()]), |
| ) |
| } |
| |
| <span class="kw">fn </span>trim_left_matches(<span class="kw-2">&</span><span class="self">self</span>, byte: u8) -> <span class="kw-2">&</span>OsStr { |
| <span class="kw">let </span><span class="kw-2">mut </span>found = <span class="bool-val">false</span>; |
| <span class="kw">for </span>(i, b) <span class="kw">in </span><span class="self">self</span>.as_bytes().iter().enumerate() { |
| <span class="kw">if </span>b != <span class="kw-2">&</span>byte { |
| <span class="kw">return </span>OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[i..]); |
| } <span class="kw">else </span>{ |
| found = <span class="bool-val">true</span>; |
| } |
| } |
| <span class="kw">if </span>found { |
| <span class="kw">return </span>OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[<span class="self">self</span>.len()..]); |
| } |
| <span class="kw-2">&*</span><span class="self">self |
| </span>} |
| |
| <span class="kw">fn </span>split_at(<span class="kw-2">&</span><span class="self">self</span>, i: usize) -> (<span class="kw-2">&</span>OsStr, <span class="kw-2">&</span>OsStr) { |
| ( |
| OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[..i]), |
| OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.as_bytes()[i..]), |
| ) |
| } |
| |
| <span class="kw">fn </span>split(<span class="kw-2">&</span><span class="self">self</span>, b: u8) -> OsSplit { |
| OsSplit { |
| sep: b, |
| val: <span class="self">self</span>.as_bytes(), |
| pos: <span class="number">0</span>, |
| } |
| } |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| #[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>OsSplit<<span class="lifetime">'a</span>> { |
| sep: u8, |
| val: <span class="kw-2">&</span><span class="lifetime">'a </span>[u8], |
| pos: usize, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>OsSplit<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>OsStr; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>OsStr> { |
| <span class="macro">debugln!</span>(<span class="string">"OsSplit::next: self={:?}"</span>, <span class="self">self</span>); |
| <span class="kw">if </span><span class="self">self</span>.pos == <span class="self">self</span>.val.len() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span>start = <span class="self">self</span>.pos; |
| <span class="kw">for </span>b <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.val[start..] { |
| <span class="self">self</span>.pos += <span class="number">1</span>; |
| <span class="kw">if </span><span class="kw-2">*</span>b == <span class="self">self</span>.sep { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.val[start..<span class="self">self</span>.pos - <span class="number">1</span>])); |
| } |
| } |
| <span class="prelude-val">Some</span>(OsStr::from_bytes(<span class="kw-2">&</span><span class="self">self</span>.val[start..])) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
