| <!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/socket/ffi.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>ffi.rs.html -- source</title> |
| |
| <link rel="stylesheet" type="text/css" href="../../../../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../rustdoc.css"> |
| <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> |
| </pre><pre class="rust "> |
| <span class="comment">// Silence invalid warnings due to rust-lang/rust#16719</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">allow</span>(<span class="ident">improper_ctypes</span>)]</span> |
| |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">libc</span>::{<span class="ident">socket</span>, <span class="ident">listen</span>, <span class="ident">bind</span>, <span class="ident">accept</span>, <span class="ident">connect</span>, <span class="ident">setsockopt</span>, <span class="ident">sendto</span>, <span class="ident">recvfrom</span>, <span class="ident">getsockname</span>, <span class="ident">getpeername</span>, <span class="ident">recv</span>, <span class="ident">send</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="ident">socklen_t</span>, <span class="ident">size_t</span>, <span class="ident">ssize_t</span>}; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>)]</span> |
| <span class="kw">use</span> <span class="ident">libc</span>::<span class="ident">c_uint</span>; |
| |
| <span class="kw">use</span> <span class="ident">sys</span>::<span class="ident">uio</span>::<span class="ident">IoVec</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">type</span> <span class="ident">type_of_cmsg_len</span> <span class="op">=</span> <span class="ident">size_t</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</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">type</span> <span class="ident">type_of_cmsg_len</span> <span class="op">=</span> <span class="ident">socklen_t</span>; |
| |
| <span class="comment">// OSX always aligns struct cmsghdr as if it were a 32-bit OS</span> |
| <span class="attribute">#[<span class="ident">cfg</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">type</span> <span class="ident">type_of_cmsg_data</span> <span class="op">=</span> <span class="ident">c_uint</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</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">type</span> <span class="ident">type_of_cmsg_data</span> <span class="op">=</span> <span class="ident">size_t</span>; |
| |
| <span class="comment">// Private because we don't expose any external functions that operate</span> |
| <span class="comment">// directly on this type; we just use it internally at FFI boundaries.</span> |
| <span class="comment">// Note that in some cases we store pointers in *const fields that the</span> |
| <span class="comment">// kernel will proceed to mutate, so users should be careful about the</span> |
| <span class="comment">// actual mutability of data pointed to by this structure.</span> |
| <span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">msghdr</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="kw">pub</span> <span class="ident">msg_name</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_void</span>, |
| <span class="kw">pub</span> <span class="ident">msg_namelen</span>: <span class="ident">socklen_t</span>, |
| <span class="kw">pub</span> <span class="ident">msg_iov</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">IoVec</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>]<span class="op">></span>, |
| <span class="kw">pub</span> <span class="ident">msg_iovlen</span>: <span class="ident">size_t</span>, |
| <span class="kw">pub</span> <span class="ident">msg_control</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_void</span>, |
| <span class="kw">pub</span> <span class="ident">msg_controllen</span>: <span class="ident">size_t</span>, |
| <span class="kw">pub</span> <span class="ident">msg_flags</span>: <span class="ident">c_int</span>, |
| } |
| |
| <span class="comment">// As above, private because we don't expose any external functions that</span> |
| <span class="comment">// operate directly on this type, or any external types with a public</span> |
| <span class="comment">// cmsghdr member.</span> |
| <span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">cmsghdr</span> { |
| <span class="kw">pub</span> <span class="ident">cmsg_len</span>: <span class="ident">type_of_cmsg_len</span>, |
| <span class="kw">pub</span> <span class="ident">cmsg_level</span>: <span class="ident">c_int</span>, |
| <span class="kw">pub</span> <span class="ident">cmsg_type</span>: <span class="ident">c_int</span>, |
| <span class="kw">pub</span> <span class="ident">cmsg_data</span>: [<span class="ident">type_of_cmsg_data</span>; <span class="number">0</span>] |
| } |
| |
| <span class="kw">extern</span> { |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">getsockopt</span>( |
| <span class="ident">sockfd</span>: <span class="ident">c_int</span>, |
| <span class="ident">level</span>: <span class="ident">c_int</span>, |
| <span class="ident">optname</span>: <span class="ident">c_int</span>, |
| <span class="ident">optval</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>, |
| <span class="ident">optlen</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">socklen_t</span>) <span class="op">-></span> <span class="ident">c_int</span>; |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">socketpair</span>( |
| <span class="ident">domain</span>: <span class="ident">c_int</span>, |
| <span class="ident">typ</span>: <span class="ident">c_int</span>, |
| <span class="ident">protocol</span>: <span class="ident">c_int</span>, |
| <span class="ident">sv</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_int</span> |
| ) <span class="op">-></span> <span class="ident">c_int</span>; |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sendmsg</span>(<span class="ident">sockfd</span>: <span class="ident">c_int</span>, <span class="ident">msg</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">msghdr</span>, <span class="ident">flags</span>: <span class="ident">c_int</span>) <span class="op">-></span> <span class="ident">ssize_t</span>; |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">recvmsg</span>(<span class="ident">sockfd</span>: <span class="ident">c_int</span>, <span class="ident">msg</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">msghdr</span>, <span class="ident">flags</span>: <span class="ident">c_int</span>) <span class="op">-></span> <span class="ident">ssize_t</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> |