| <!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 `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/nix-0.8.1/src/lib.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>lib.rs.html -- source</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 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"> |
| |
| |
| </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"><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> |
| <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> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! Rust friendly bindings to the various *nix system functions.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! Modules are structured according to the C header file that they would be</span> |
| <span class="doccomment">//! defined in.</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">crate_name</span> <span class="op">=</span> <span class="string">"nix"</span>]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">allow</span>(<span class="ident">non_camel_case_types</span>)]</span> |
| <span class="comment">// latest bitflags triggers a rustc bug with cross-crate macro expansions causing dead_code</span> |
| <span class="comment">// warnings even though the macro expands into something with allow(dead_code)</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">test</span>, <span class="ident">deny</span>(<span class="ident">warnings</span>))]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">recursion_limit</span> <span class="op">=</span> <span class="string">"500"</span>]</span> |
| |
| <span class="attribute">#[<span class="ident">macro_use</span>]</span> |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">bitflags</span>; |
| |
| <span class="attribute">#[<span class="ident">macro_use</span>]</span> |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">cfg_if</span>; |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">void</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">nix_test</span> <span class="kw">as</span> <span class="ident">nixtest</span>; |
| |
| <span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">mod</span> <span class="ident">macros</span>; |
| |
| <span class="comment">// In rust 1.8+ this should be `pub extern crate libc` but prior</span> |
| <span class="comment">// to https://github.com/rust-lang/rust/issues/26775 being resolved</span> |
| <span class="comment">// it is necessary to get a little creative.</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">libc</span> { |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">libc</span>; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">libc</span>::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">libc</span>::{<span class="ident">c_int</span>, <span class="ident">c_void</span>}; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">errno</span>::<span class="ident">Errno</span>; |
| |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">errno</span>; |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">features</span>; |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">fcntl</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>))]</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">mount</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">mqueue</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>))]</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">poll</span>; |
| |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">net</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>))]</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sched</span>; |
| |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sys</span>; |
| |
| <span class="comment">// This can be implemented for other platforms as soon as libc</span> |
| <span class="comment">// provides bindings for them.</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, |
| <span class="ident">any</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86_64"</span>)))]</span> |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">ucontext</span>; |
| |
| <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">unistd</span>; |
| |
| <span class="comment">/* |
| * |
| * ===== Result / Error ===== |
| * |
| */</span> |
| |
| <span class="kw">use</span> <span class="ident">libc</span>::<span class="ident">c_char</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">ptr</span>, <span class="ident">result</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::{<span class="ident">CStr</span>, <span class="ident">OsStr</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::{<span class="ident">Path</span>, <span class="ident">PathBuf</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">ffi</span>::<span class="ident">OsStrExt</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>; |
| <span class="kw">use</span> <span class="ident">libc</span>::<span class="ident">PATH_MAX</span>; |
| |
| <span class="doccomment">/// Nix Result Type</span> |
| <span class="kw">pub</span> <span class="kw">type</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Error</span><span class="op">></span>; |
| |
| <span class="doccomment">/// Nix Error Type</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The nix error type provides a common way of dealing with</span> |
| <span class="doccomment">/// various system system/libc calls that might fail. Each</span> |
| <span class="doccomment">/// error has a corresponding errno (usually the one from the</span> |
| <span class="doccomment">/// underlying OS) to which it can be mapped in addition to</span> |
| <span class="doccomment">/// implementing other common traits.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> { |
| <span class="ident">Sys</span>(<span class="ident">errno</span>::<span class="ident">Errno</span>), |
| <span class="ident">InvalidPath</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Error</span> { |
| |
| <span class="doccomment">/// Create a nix Error from a given errno</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_errno</span>(<span class="ident">errno</span>: <span class="ident">errno</span>::<span class="ident">Errno</span>) <span class="op">-></span> <span class="ident">Error</span> { |
| <span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>) |
| } |
| |
| <span class="doccomment">/// Get the current errno and convert it to a nix Error</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">last</span>() <span class="op">-></span> <span class="ident">Error</span> { |
| <span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>::<span class="ident">Errno</span>::<span class="ident">last</span>()) |
| } |
| |
| <span class="doccomment">/// Create a new invalid argument error (`EINVAL`)</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">invalid_argument</span>() <span class="op">-></span> <span class="ident">Error</span> { |
| <span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>::<span class="ident">EINVAL</span>) |
| } |
| |
| <span class="doccomment">/// Get the errno associated with this error</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">errno</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">errno</span>::<span class="ident">Errno</span> { |
| <span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> { |
| <span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>) <span class="op">=></span> <span class="ident">errno</span>, |
| <span class="ident">Error</span>::<span class="ident">InvalidPath</span> <span class="op">=></span> <span class="ident">errno</span>::<span class="ident">Errno</span>::<span class="ident">EINVAL</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">errno</span>::<span class="ident">Errno</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Error</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">errno</span>: <span class="ident">errno</span>::<span class="ident">Errno</span>) <span class="op">-></span> <span class="ident">Error</span> { <span class="ident">Error</span>::<span class="ident">from_errno</span>(<span class="ident">errno</span>) } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">Error</span> { |
| <span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> { |
| <span class="kw">match</span> <span class="self">self</span> { |
| <span class="kw-2">&</span><span class="ident">Error</span>::<span class="ident">InvalidPath</span> <span class="op">=></span> <span class="string">"Invalid path"</span>, |
| <span class="kw-2">&</span><span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="kw-2">ref</span> <span class="ident">errno</span>) <span class="op">=></span> <span class="ident">errno</span>.<span class="ident">desc</span>(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Error</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="kw">match</span> <span class="self">self</span> { |
| <span class="kw-2">&</span><span class="ident">Error</span>::<span class="ident">InvalidPath</span> <span class="op">=></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"Invalid path"</span>), |
| <span class="kw-2">&</span><span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>) <span class="op">=></span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{:?}: {}"</span>, <span class="ident">errno</span>, <span class="ident">errno</span>.<span class="ident">desc</span>()), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">io</span>::<span class="ident">Error</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">Error</span>) <span class="op">-></span> <span class="self">Self</span> { |
| <span class="kw">match</span> <span class="ident">err</span> { |
| <span class="ident">Error</span>::<span class="ident">InvalidPath</span> <span class="op">=></span> <span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">InvalidInput</span>, <span class="ident">err</span>), |
| <span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">errno</span>) <span class="op">=></span> <span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">from_raw_os_error</span>(<span class="ident">errno</span> <span class="kw">as</span> <span class="ident">i32</span>), |
| } |
| } |
| } |
| |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">NixPath</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span>; |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span>; |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="ident">str</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="ident">NixPath</span>::<span class="ident">len</span>(<span class="ident">OsStr</span>::<span class="ident">new</span>(<span class="self">self</span>)) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="ident">OsStr</span>::<span class="ident">new</span>(<span class="self">self</span>).<span class="ident">with_nix_path</span>(<span class="ident">f</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="ident">OsStr</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">as_bytes</span>().<span class="ident">len</span>() |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="self">self</span>.<span class="ident">as_bytes</span>().<span class="ident">with_nix_path</span>(<span class="ident">f</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="ident">CStr</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">to_bytes</span>().<span class="ident">len</span>() |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="comment">// Equivalence with the [u8] impl.</span> |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">len</span>() <span class="op">>=</span> <span class="ident">PATH_MAX</span> <span class="kw">as</span> <span class="ident">usize</span> { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">InvalidPath</span>); |
| } |
| |
| <span class="prelude-val">Ok</span>(<span class="ident">f</span>(<span class="self">self</span>)) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> [<span class="ident">u8</span>] { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">len</span>() |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0u8</span>; <span class="ident">PATH_MAX</span> <span class="kw">as</span> <span class="ident">usize</span>]; |
| |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">len</span>() <span class="op">>=</span> <span class="ident">PATH_MAX</span> <span class="kw">as</span> <span class="ident">usize</span> { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">InvalidPath</span>); |
| } |
| |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">iter</span>().<span class="ident">position</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> <span class="kw-2">*</span><span class="ident">b</span> <span class="op">==</span> <span class="number">0</span>) { |
| <span class="prelude-val">Some</span>(_) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">InvalidPath</span>), |
| <span class="prelude-val">None</span> <span class="op">=></span> { |
| <span class="kw">unsafe</span> { |
| <span class="comment">// TODO: Replace with bytes::copy_memory. rust-lang/rust#24028</span> |
| <span class="ident">ptr</span>::<span class="ident">copy_nonoverlapping</span>(<span class="self">self</span>.<span class="ident">as_ptr</span>(), <span class="ident">buf</span>.<span class="ident">as_mut_ptr</span>(), <span class="self">self</span>.<span class="ident">len</span>()); |
| <span class="prelude-val">Ok</span>(<span class="ident">f</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">buf</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>))) |
| } |
| |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="ident">Path</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="ident">NixPath</span>::<span class="ident">len</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>()) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">with_nix_path</span>(<span class="ident">f</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="ident">PathBuf</span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="ident">NixPath</span>::<span class="ident">len</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>()) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">with_nix_path</span>(<span class="ident">f</span>) |
| } |
| } |
| |
| <span class="doccomment">/// Treats `None` as an empty string.</span> |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">NP</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">NixPath</span><span class="op">></span> <span class="ident">NixPath</span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">NP</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">map_or</span>(<span class="number">0</span>, <span class="ident">NixPath</span>::<span class="ident">len</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">with_nix_path</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">nix_path</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="self">self</span> { |
| <span class="ident">nix_path</span>.<span class="ident">with_nix_path</span>(<span class="ident">f</span>) |
| } <span class="kw">else</span> { |
| <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="string">"\0"</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> _).<span class="ident">with_nix_path</span>(<span class="ident">f</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>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</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 = "nix"; |
| </script> |
| <script src="../../main.js"></script> |
| <script defer src="../../search-index.js"></script> |
| </body> |
| </html> |