|
|
<!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" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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"><div class="sidebar-menu">☰</div><a href='../nix/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate nix</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all nix's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><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></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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-283' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>nix</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='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
<table><tr><td><code>pub extern crate <a class="mod" href="../libc/index.html" title="mod libc">libc</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="dir/index.html" title='nix::dir mod'>dir</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="errno/index.html" title='nix::errno mod'>errno</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="fcntl/index.html" title='nix::fcntl mod'>fcntl</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="features/index.html" title='nix::features mod'>features</a></td><td class='docblock-short'><p>Feature tests for OS functionality</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="ifaddrs/index.html" title='nix::ifaddrs mod'>ifaddrs</a></td><td class='docblock-short'><p>Query network interface addresses</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="kmod/index.html" title='nix::kmod mod'>kmod</a></td><td class='docblock-short'><p>Load and unload kernel modules.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="mount/index.html" title='nix::mount mod'>mount</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="mqueue/index.html" title='nix::mqueue mod'>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='nix::net mod'>net</a></td><td class='docblock-short'><p>Functionality involving network interfaces</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="poll/index.html" title='nix::poll mod'>poll</a></td><td class='docblock-short'><p>Wait for events to trigger on specific file descriptors</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="pty/index.html" title='nix::pty mod'>pty</a></td><td class='docblock-short'><p>Create master and slave virtual pseudo-terminals (PTYs)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="sched/index.html" title='nix::sched mod'>sched</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="sys/index.html" title='nix::sys mod'>sys</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="ucontext/index.html" title='nix::ucontext mod'>ucontext</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="unistd/index.html" title='nix::unistd mod'>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.cmsg_space.html" title='nix::cmsg_space macro'>cmsg_space</a></td><td class='docblock-short'><p>Create a buffer large enough for storing some control messages as returned
|
|
|
by <a href="fn.recvmsg.html"><code>recvmsg</code></a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_none.html" title='nix::ioctl_none macro'>ioctl_none</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that passes no data to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_none_bad.html" title='nix::ioctl_none_bad macro'>ioctl_none_bad</a></td><td class='docblock-short'><p>Generates a wrapper function for a "bad" ioctl that passes no data to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_read.html" title='nix::ioctl_read macro'>ioctl_read</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that reads data from the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_read_bad.html" title='nix::ioctl_read_bad macro'>ioctl_read_bad</a></td><td class='docblock-short'><p>Generates a wrapper function for a "bad" ioctl that reads data from the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_read_buf.html" title='nix::ioctl_read_buf macro'>ioctl_read_buf</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that reads an array of elements from the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_readwrite.html" title='nix::ioctl_readwrite macro'>ioctl_readwrite</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that reads and writes data to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_readwrite_bad.html" title='nix::ioctl_readwrite_bad macro'>ioctl_readwrite_bad</a></td><td class='docblock-short'><p>Generates a wrapper function for a "bad" ioctl that reads and writes data to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_readwrite_buf.html" title='nix::ioctl_readwrite_buf macro'>ioctl_readwrite_buf</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that reads and writes an array of elements to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_write_buf.html" title='nix::ioctl_write_buf macro'>ioctl_write_buf</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that writes an array of elements to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_write_int.html" title='nix::ioctl_write_int macro'>ioctl_write_int</a></td><td class='docblock-short'><p>Generates a wrapper function for a ioctl that writes an integer to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_write_int_bad.html" title='nix::ioctl_write_int_bad macro'>ioctl_write_int_bad</a></td><td class='docblock-short'><p>Generates a wrapper function for a "bad" ioctl that writes an integer to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_write_ptr.html" title='nix::ioctl_write_ptr macro'>ioctl_write_ptr</a></td><td class='docblock-short'><p>Generates a wrapper function for an ioctl that writes data through a pointer to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.ioctl_write_ptr_bad.html" title='nix::ioctl_write_ptr_bad macro'>ioctl_write_ptr_bad</a></td><td class='docblock-short'><p>Generates a wrapper function for a "bad" ioctl that writes data through a pointer to the kernel.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.request_code_none.html" title='nix::request_code_none macro'>request_code_none</a></td><td class='docblock-short'><p>Generate an ioctl request code for a command that passes no data.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.request_code_read.html" title='nix::request_code_read macro'>request_code_read</a></td><td class='docblock-short'><p>Generate an ioctl request code for a command that reads.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.request_code_readwrite.html" title='nix::request_code_readwrite macro'>request_code_readwrite</a></td><td class='docblock-short'><p>Generate an ioctl request code for a command that reads and writes.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="macro" href="macro.request_code_write.html" title='nix::request_code_write macro'>request_code_write</a></td><td class='docblock-short'><p>Generate an ioctl request code for a 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.Error.html" title='nix::Error enum'>Error</a></td><td class='docblock-short'><p>Nix Error Type</p>
|
|
|
</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='nix::NixPath trait'>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='nix::Result type'>Result</a></td><td class='docblock-short'><p>Nix Result Type</p>
|
|
|
</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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "nix";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
