| <!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="API documentation for the Rust `nix` crate."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, nix"> |
| |
| <title>nix - Rust</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 mod"> |
| <!--[if lte IE 8]> |
| <div class="warning"> |
| This old browser is unsupported and will most likely display funky |
| things. |
| </div> |
| <![endif]--> |
| |
| |
| |
| <nav class="sidebar"> |
| |
| <p class='location'>Crate nix</p><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'nix', ty: 'mod', relpath: '../'};</script> |
| </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"> |
| <h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>nix</a></span><span class='out-of-band'><span id='render-detail'> |
| <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> |
| [<span class='inner'>−</span>] |
| </a> |
| </span><a class='srclink' href='../src/nix/lib.rs.html#1-259' title='goto source code'>[src]</a></span></h1> |
| <div class='docblock'><p>Rust friendly bindings to the various *nix system functions.</p> |
| |
| <p>Modules are structured according to the C header file that they would be |
| defined in.</p> |
| </div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2> |
| <table> |
| <tr class=' module-item'> |
| <td><a class="mod" href="errno/index.html" |
| title='mod nix::errno'>errno</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="fcntl/index.html" |
| title='mod nix::fcntl'>fcntl</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="features/index.html" |
| title='mod nix::features'>features</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="libc/index.html" |
| title='mod nix::libc'>libc</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="mount/index.html" |
| title='mod nix::mount'>mount</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="mqueue/index.html" |
| title='mod nix::mqueue'>mqueue</a></td> |
| <td class='docblock-short'> |
| <p>Posix Message Queue functions</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="net/index.html" |
| title='mod nix::net'>net</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="poll/index.html" |
| title='mod nix::poll'>poll</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="sched/index.html" |
| title='mod nix::sched'>sched</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="sys/index.html" |
| title='mod nix::sys'>sys</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="ucontext/index.html" |
| title='mod nix::ucontext'>ucontext</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="mod" href="unistd/index.html" |
| title='mod nix::unistd'>unistd</a></td> |
| <td class='docblock-short'> |
| <p>Safe wrappers around functions found in libc "unistd.h" header</p> |
| </td> |
| </tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2> |
| <table> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.convert_ioctl_res.html" |
| title='macro nix::convert_ioctl_res'>convert_ioctl_res</a></td> |
| <td class='docblock-short'> |
| <p>Convert raw ioctl return value to a Nix result</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.io.html" |
| title='macro nix::io'>io</a></td> |
| <td class='docblock-short'> |
| <p>Encode an ioctl command that has no associated data.</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.ioc.html" |
| title='macro nix::ioc'>ioc</a></td> |
| <td class='docblock-short'> |
| <p>Encode an ioctl command.</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.ioctl.html" |
| title='macro nix::ioctl'>ioctl</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.ior.html" |
| title='macro nix::ior'>ior</a></td> |
| <td class='docblock-short'> |
| <p>Encode an ioctl command that reads.</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.iorw.html" |
| title='macro nix::iorw'>iorw</a></td> |
| <td class='docblock-short'> |
| <p>Encode an ioctl command that both reads and writes.</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="macro" href="macro.iow.html" |
| title='macro nix::iow'>iow</a></td> |
| <td class='docblock-short'> |
| <p>Encode an ioctl command that writes.</p> |
| </td> |
| </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2> |
| <table> |
| <tr class=' module-item'> |
| <td><a class="enum" href="enum.Errno.html" |
| title='enum nix::Errno'>Errno</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="enum" href="enum.Error.html" |
| title='enum nix::Error'>Error</a></td> |
| <td class='docblock-short'> |
| <p>Nix Error Type</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="enum" href="enum.c_void.html" |
| title='enum nix::c_void'>c_void</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2> |
| <table> |
| <tr class=' module-item'> |
| <td><a class="trait" href="trait.NixPath.html" |
| title='trait nix::NixPath'>NixPath</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2> |
| <table> |
| <tr class=' module-item'> |
| <td><a class="type" href="type.Result.html" |
| title='type nix::Result'>Result</a></td> |
| <td class='docblock-short'> |
| <p>Nix Result Type</p> |
| </td> |
| </tr> |
| <tr class=' module-item'> |
| <td><a class="type" href="type.c_int.html" |
| title='type nix::c_int'>c_int</a></td> |
| <td class='docblock-short'> |
| |
| </td> |
| </tr></table></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> |
