| <!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/nix-0.26.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../nix/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="../../nix/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> |
| <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> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Rust friendly bindings to the various *nix system functions. |
| //! |
| //! Modules are structured according to the C header file that they would be |
| //! defined in. |
| //! |
| //! # Features |
| //! |
| //! Nix uses the following Cargo features to enable optional functionality. |
| //! They may be enabled in any combination. |
| //! * `acct` - Process accounting |
| //! * `aio` - POSIX AIO |
| //! * `dir` - Stuff relating to directory iteration |
| //! * `env` - Manipulate environment variables |
| //! * `event` - Event-driven APIs, like `kqueue` and `epoll` |
| //! * `feature` - Query characteristics of the OS at runtime |
| //! * `fs` - File system functionality |
| //! * `hostname` - Get and set the system's hostname |
| //! * `inotify` - Linux's `inotify` file system notification API |
| //! * `ioctl` - The `ioctl` syscall, and wrappers for my specific instances |
| //! * `kmod` - Load and unload kernel modules |
| //! * `mman` - Stuff relating to memory management |
| //! * `mount` - Mount and unmount file systems |
| //! * `mqueue` - POSIX message queues |
| //! * `net` - Networking-related functionality |
| //! * `personality` - Set the process execution domain |
| //! * `poll` - APIs like `poll` and `select` |
| //! * `process` - Stuff relating to running processes |
| //! * `pthread` - POSIX threads |
| //! * `ptrace` - Process tracing and debugging |
| //! * `quota` - File system quotas |
| //! * `reboot` - Reboot the system |
| //! * `resource` - Process resource limits |
| //! * `sched` - Manipulate process's scheduling |
| //! * `socket` - Sockets, whether for networking or local use |
| //! * `signal` - Send and receive signals to processes |
| //! * `term` - Terminal control APIs |
| //! * `time` - Query the operating system's clocks |
| //! * `ucontext` - User thread context |
| //! * `uio` - Vectored I/O |
| //! * `user` - Stuff relating to users and groups |
| //! * `zerocopy` - APIs like `sendfile` and `copy_file_range` |
| </span><span class="attribute">#![crate_name = <span class="string">"nix"</span>] |
| #![cfg(unix)] |
| #![cfg_attr(docsrs, doc(cfg(all())))] |
| #![allow(non_camel_case_types)] |
| #![cfg_attr(test, deny(warnings))] |
| #![recursion_limit = <span class="string">"500"</span>] |
| #![deny(unused)] |
| #![allow(unused_macros)] |
| #![cfg_attr(not(feature = <span class="string">"default"</span>), allow(unused_imports))] |
| #![deny(unstable_features)] |
| #![deny(missing_copy_implementations)] |
| #![deny(missing_debug_implementations)] |
| #![warn(missing_docs)] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| #![deny(clippy::cast_ptr_alignment)] |
| |
| </span><span class="comment">// Re-exported external crates |
| </span><span class="kw">pub use </span>libc; |
| |
| <span class="comment">// Private internal modules |
| </span><span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| |
| <span class="comment">// Public crates |
| </span><span class="attribute">#[cfg(not(target_os = <span class="string">"redox"</span>))] |
| </span><span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"dir"</span>] |
| </span><span class="kw">pub mod </span>dir; |
| } |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"env"</span>] |
| </span><span class="kw">pub mod </span>env; |
| } |
| <span class="attribute">#[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>errno; |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"feature"</span>] |
| |
| #[deny(missing_docs)] |
| </span><span class="kw">pub mod </span>features; |
| } |
| <span class="attribute">#[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>fcntl; |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"net"</span>] |
| |
| #[cfg(any(target_os = <span class="string">"android"</span>, |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"ios"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"macos"</span>, |
| target_os = <span class="string">"netbsd"</span>, |
| target_os = <span class="string">"illumos"</span>, |
| target_os = <span class="string">"openbsd"</span>))] |
| #[deny(missing_docs)] |
| </span><span class="kw">pub mod </span>ifaddrs; |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"redox"</span>))] |
| #[deny(missing_docs)] |
| </span><span class="kw">pub mod </span>net; |
| } |
| <span class="attribute">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))] |
| </span><span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"kmod"</span>] |
| #[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>kmod; |
| } |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"mount"</span>] |
| </span><span class="kw">pub mod </span>mount; |
| } |
| <span class="attribute">#[cfg(any( |
| target_os = <span class="string">"dragonfly"</span>, |
| target_os = <span class="string">"freebsd"</span>, |
| target_os = <span class="string">"linux"</span>, |
| target_os = <span class="string">"netbsd" |
| </span>))] |
| </span><span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"mqueue"</span>] |
| </span><span class="kw">pub mod </span>mqueue; |
| } |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"poll"</span>] |
| </span><span class="kw">pub mod </span>poll; |
| } |
| <span class="attribute">#[cfg(not(any(target_os = <span class="string">"redox"</span>, target_os = <span class="string">"fuchsia"</span>)))] |
| </span><span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"term"</span>] |
| #[deny(missing_docs)] |
| </span><span class="kw">pub mod </span>pty; |
| } |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"sched"</span>] |
| </span><span class="kw">pub mod </span>sched; |
| } |
| <span class="kw">pub mod </span>sys; |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"time"</span>] |
| #[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>time; |
| } |
| <span class="comment">// This can be implemented for other platforms as soon as libc |
| // provides bindings for them. |
| </span><span class="attribute">#[cfg(all( |
| target_os = <span class="string">"linux"</span>, |
| any(target_arch = <span class="string">"s390x"</span>, target_arch = <span class="string">"x86"</span>, target_arch = <span class="string">"x86_64"</span>) |
| ))] |
| </span><span class="macro">feature! </span>{ |
| <span class="attribute">#![feature = <span class="string">"ucontext"</span>] |
| #[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>ucontext; |
| } |
| <span class="attribute">#[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>unistd; |
| |
| <span class="kw">use </span>std::ffi::{CStr, CString, OsStr}; |
| <span class="kw">use </span>std::mem::MaybeUninit; |
| <span class="kw">use </span>std::os::unix::ffi::OsStrExt; |
| <span class="kw">use </span>std::path::{Path, PathBuf}; |
| <span class="kw">use </span>std::{ptr, result, slice}; |
| |
| <span class="kw">use </span>errno::Errno; |
| |
| <span class="doccomment">/// Nix Result Type |
| </span><span class="kw">pub type </span><span class="prelude-ty">Result</span><T> = result::Result<T, Errno>; |
| |
| <span class="doccomment">/// Nix's main error type. |
| /// |
| /// It's a wrapper around Errno. As such, it's very interoperable with |
| /// [`std::io::Error`], but it has the advantages of: |
| /// * `Clone` |
| /// * `Copy` |
| /// * `Eq` |
| /// * Small size |
| /// * Represents all of the system's errnos, instead of just the most common |
| /// ones. |
| </span><span class="kw">pub type </span>Error = Errno; |
| |
| <span class="doccomment">/// Common trait used to represent file system paths by many Nix functions. |
| </span><span class="kw">pub trait </span>NixPath { |
| <span class="doccomment">/// Is the path empty? |
| </span><span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool; |
| |
| <span class="doccomment">/// Length of the path in bytes |
| </span><span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize; |
| |
| <span class="doccomment">/// Execute a function with this path as a `CStr`. |
| /// |
| /// Mostly used internally by Nix. |
| </span><span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T; |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>str { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| NixPath::is_empty(OsStr::new(<span class="self">self</span>)) |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| NixPath::len(OsStr::new(<span class="self">self</span>)) |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| OsStr::new(<span class="self">self</span>).with_nix_path(f) |
| } |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>OsStr { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.as_bytes().is_empty() |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.as_bytes().len() |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="self">self</span>.as_bytes().with_nix_path(f) |
| } |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>CStr { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.to_bytes().is_empty() |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.to_bytes().len() |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="prelude-val">Ok</span>(f(<span class="self">self</span>)) |
| } |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>[u8] { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.is_empty() |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.len() |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="comment">// The real PATH_MAX is typically 4096, but it's statistically unlikely to have a path |
| // longer than ~300 bytes. See the the PR description to get stats for your own machine. |
| // https://github.com/nix-rust/nix/pull/1656 |
| // |
| // By being smaller than a memory page, we also avoid the compiler inserting a probe frame: |
| // https://docs.rs/compiler_builtins/latest/compiler_builtins/probestack/index.html |
| </span><span class="kw">const </span>MAX_STACK_ALLOCATION: usize = <span class="number">1024</span>; |
| |
| <span class="kw">if </span><span class="self">self</span>.len() >= MAX_STACK_ALLOCATION { |
| <span class="kw">return </span>with_nix_path_allocating(<span class="self">self</span>, f); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = MaybeUninit::<[u8; MAX_STACK_ALLOCATION]>::uninit(); |
| <span class="kw">let </span>buf_ptr = buf.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>u8; |
| |
| <span class="kw">unsafe </span>{ |
| ptr::copy_nonoverlapping(<span class="self">self</span>.as_ptr(), buf_ptr, <span class="self">self</span>.len()); |
| buf_ptr.add(<span class="self">self</span>.len()).write(<span class="number">0</span>); |
| } |
| |
| <span class="kw">match </span>CStr::from_bytes_with_nul(<span class="kw">unsafe </span>{ |
| slice::from_raw_parts(buf_ptr, <span class="self">self</span>.len() + <span class="number">1</span>) |
| }) { |
| <span class="prelude-val">Ok</span>(s) => <span class="prelude-val">Ok</span>(f(s)), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="prelude-val">Err</span>(Errno::EINVAL), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cold] |
| #[inline(never)] |
| </span><span class="kw">fn </span>with_nix_path_allocating<T, F>(from: <span class="kw-2">&</span>[u8], f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="kw">match </span>CString::new(from) { |
| <span class="prelude-val">Ok</span>(s) => <span class="prelude-val">Ok</span>(f(<span class="kw-2">&</span>s)), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="prelude-val">Err</span>(Errno::EINVAL), |
| } |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>Path { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| NixPath::is_empty(<span class="self">self</span>.as_os_str()) |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| NixPath::len(<span class="self">self</span>.as_os_str()) |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="self">self</span>.as_os_str().with_nix_path(f) |
| } |
| } |
| |
| <span class="kw">impl </span>NixPath <span class="kw">for </span>PathBuf { |
| <span class="kw">fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| NixPath::is_empty(<span class="self">self</span>.as_os_str()) |
| } |
| |
| <span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| NixPath::len(<span class="self">self</span>.as_os_str()) |
| } |
| |
| <span class="kw">fn </span>with_nix_path<T, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> <span class="prelude-ty">Result</span><T> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>CStr) -> T, |
| { |
| <span class="self">self</span>.as_os_str().with_nix_path(f) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="nix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |