| <!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/sys/ioctl/mod.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>mod.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> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! Provide helpers for making ioctl system calls</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! Currently supports Linux on all architectures. Other platforms welcome!</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! This library is pretty low-level and messy. `ioctl` is not fun.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! What is an `ioctl`?</span> |
| <span class="doccomment">//! ===================</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! The `ioctl` syscall is the grab-bag syscall on POSIX systems. Don't want</span> |
| <span class="doccomment">//! to add a new syscall? Make it an `ioctl`! `ioctl` refers to both the syscall,</span> |
| <span class="doccomment">//! and the commands that can be send with it. `ioctl` stands for "IO control",</span> |
| <span class="doccomment">//! and the commands are always sent to a file descriptor.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! It is common to see `ioctl`s used for the following purposes:</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! * Provide read/write access to out-of-band data related</span> |
| <span class="doccomment">//! to a device such as configuration (for instance, setting</span> |
| <span class="doccomment">//! serial port options)</span> |
| <span class="doccomment">//! * Provide a mechanism for performing full-duplex data</span> |
| <span class="doccomment">//! transfers (for instance, xfer on SPI devices).</span> |
| <span class="doccomment">//! * Provide access to control functions on a device (for example,</span> |
| <span class="doccomment">//! on Linux you can send commands like pause, resume, and eject</span> |
| <span class="doccomment">//! to the CDROM device.</span> |
| <span class="doccomment">//! * Do whatever else the device driver creator thought made most sense.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! `ioctl`s are synchronous system calls and are similar to read and</span> |
| <span class="doccomment">//! write calls in that regard.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! What does this module support?</span> |
| <span class="doccomment">//! ===============================</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! This library provides the `ioctl!` macro, for binding `ioctl`s.</span> |
| <span class="doccomment">//! Here's a few examples of how that can work for SPI under Linux</span> |
| <span class="doccomment">//! from [rust-spidev](https://github.com/posborne/rust-spidev).</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! ```</span> |
| <span class="doccomment">//! #[macro_use] extern crate nix;</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! #[allow(non_camel_case_types)]</span> |
| <span class="doccomment">//! pub struct spi_ioc_transfer {</span> |
| <span class="doccomment">//! pub tx_buf: u64,</span> |
| <span class="doccomment">//! pub rx_buf: u64,</span> |
| <span class="doccomment">//! pub len: u32,</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! // optional overrides</span> |
| <span class="doccomment">//! pub speed_hz: u32,</span> |
| <span class="doccomment">//! pub delay_usecs: u16,</span> |
| <span class="doccomment">//! pub bits_per_word: u8,</span> |
| <span class="doccomment">//! pub cs_change: u8,</span> |
| <span class="doccomment">//! pub pad: u32,</span> |
| <span class="doccomment">//! }</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! #[cfg(linux)]</span> |
| <span class="doccomment">//! mod ioctl {</span> |
| <span class="doccomment">//! use super::*;</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! const SPI_IOC_MAGIC: u8 = 'k' as u8;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_TRANSFER: u8 = 0;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_MODE: u8 = 1;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_LSB_FIRST: u8 = 2;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_BITS_PER_WORD: u8 = 3;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_MAX_SPEED_HZ: u8 = 4;</span> |
| <span class="doccomment">//! const SPI_IOC_NR_MODE32: u8 = 5;</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! ioctl!(read get_mode_u8 with SPI_IOC_MAGIC, SPI_IOC_NR_MODE; u8);</span> |
| <span class="doccomment">//! ioctl!(read get_mode_u32 with SPI_IOC_MAGIC, SPI_IOC_NR_MODE; u32);</span> |
| <span class="doccomment">//! ioctl!(write set_mode_u8 with SPI_IOC_MAGIC, SPI_IOC_NR_MODE; u8);</span> |
| <span class="doccomment">//! ioctl!(write set_mode_u32 with SPI_IOC_MAGIC, SPI_IOC_NR_MODE32; u32);</span> |
| <span class="doccomment">//! ioctl!(read get_lsb_first with SPI_IOC_MAGIC, SPI_IOC_NR_LSB_FIRST; u8);</span> |
| <span class="doccomment">//! ioctl!(write set_lsb_first with SPI_IOC_MAGIC, SPI_IOC_NR_LSB_FIRST; u8);</span> |
| <span class="doccomment">//! ioctl!(read get_bits_per_word with SPI_IOC_MAGIC, SPI_IOC_NR_BITS_PER_WORD; u8);</span> |
| <span class="doccomment">//! ioctl!(write set_bits_per_word with SPI_IOC_MAGIC, SPI_IOC_NR_BITS_PER_WORD; u8);</span> |
| <span class="doccomment">//! ioctl!(read get_max_speed_hz with SPI_IOC_MAGIC, SPI_IOC_NR_MAX_SPEED_HZ; u32);</span> |
| <span class="doccomment">//! ioctl!(write set_max_speed_hz with SPI_IOC_MAGIC, SPI_IOC_NR_MAX_SPEED_HZ; u32);</span> |
| <span class="doccomment">//! ioctl!(write spidev_transfer with SPI_IOC_MAGIC, SPI_IOC_NR_TRANSFER; spi_ioc_transfer);</span> |
| <span class="doccomment">//! ioctl!(write buf spidev_transfer_buf with SPI_IOC_MAGIC, SPI_IOC_NR_TRANSFER; spi_ioc_transfer);</span> |
| <span class="doccomment">//! }</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! // doctest workaround</span> |
| <span class="doccomment">//! fn main() {}</span> |
| <span class="doccomment">//! ```</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! Spidev uses the `_IOC` macros that are encouraged (as far as</span> |
| <span class="doccomment">//! `ioctl` can be encouraged at all) for newer drivers. Many</span> |
| <span class="doccomment">//! drivers, however, just use magic numbers with no attached</span> |
| <span class="doccomment">//! semantics. For those, the `ioctl!(bad ...)` variant should be</span> |
| <span class="doccomment">//! used (the "bad" terminology is from the Linux kernel).</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! How do I get the magic numbers?</span> |
| <span class="doccomment">//! ===============================</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! For Linux, look at your system's headers. For example, `/usr/include/linux/input.h` has a lot</span> |
| <span class="doccomment">//! of lines defining macros which use `_IOR`, `_IOW`, `_IOC`, and `_IORW`. These macros</span> |
| <span class="doccomment">//! correspond to the `ior!`, `iow!`, `ioc!`, and `iorw!` macros defined in this crate.</span> |
| <span class="doccomment">//! Additionally, there is the `ioctl!` macro for creating a wrapper around `ioctl` that is</span> |
| <span class="doccomment">//! somewhat more type-safe.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! Most `ioctl`s have no or little documentation. You'll need to scrounge through</span> |
| <span class="doccomment">//! the source to figure out what they do and how they should be used.</span> |
| <span class="doccomment">//!</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="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"platform/linux.rs"</span>]</span> |
| <span class="attribute">#[<span class="ident">macro_use</span>]</span> |
| <span class="kw">mod</span> <span class="ident">platform</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">"macos"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"openbsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, |
| <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>))]</span> |
| <span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"platform/bsd.rs"</span>]</span> |
| <span class="attribute">#[<span class="ident">macro_use</span>]</span> |
| <span class="kw">mod</span> <span class="ident">platform</span>; |
| |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">platform</span>::<span class="kw-2">*</span>; |
| |
| <span class="comment">// liblibc has the wrong decl for linux :| hack until #26809 lands.</span> |
| <span class="kw">extern</span> <span class="string">"C"</span> { |
| <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ioctl</span>(<span class="ident">fd</span>: <span class="ident">libc</span>::<span class="ident">c_int</span>, <span class="ident">req</span>: <span class="ident">libc</span>::<span class="ident">c_ulong</span>, ...) <span class="op">-></span> <span class="ident">libc</span>::<span class="ident">c_int</span>; |
| } |
| |
| <span class="doccomment">/// A hack to get the macros to work nicely.</span> |
| <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">use</span> ::<span class="ident">libc</span> <span class="kw">as</span> <span class="ident">libc</span>; |
| |
| <span class="doccomment">/// Convert raw ioctl return value to a Nix result</span> |
| <span class="attribute">#[<span class="ident">macro_export</span>]</span> |
| <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">convert_ioctl_res</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">w</span>:<span class="ident">expr</span>) <span class="op">=></span> ( |
| { |
| <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">Errno</span>::<span class="ident">result</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">w</span>) |
| } |
| ); |
| } |
| |
| <span class="attribute">#[<span class="ident">macro_export</span>]</span> |
| <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl</span> { |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">data</span>)) |
| } |
| ); |
| (<span class="ident">none</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">io</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>)) |
| } |
| ); |
| (<span class="ident">read</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">ior</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</span>)) |
| } |
| ); |
| (<span class="ident">write</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">iow</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</span>)) |
| } |
| ); |
| (<span class="ident">readwrite</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">iorw</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</span>)) |
| } |
| ); |
| (<span class="ident">read</span> <span class="ident">buf</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>, |
| <span class="ident">len</span>: <span class="ident">usize</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">ior</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">len</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</span>)) |
| } |
| ); |
| (<span class="ident">write</span> <span class="ident">buf</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>, |
| <span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">iow</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">len</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</span>)) |
| } |
| ); |
| (<span class="ident">readwrite</span> <span class="ident">buf</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="ident">with</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=></span> ( |
| <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span>, |
| <span class="ident">val</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>, |
| <span class="ident">len</span>: <span class="ident">usize</span>) |
| <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { |
| <span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">iorw</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">len</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">libc</span>::<span class="ident">c_ulong</span>, <span class="ident">val</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> |
