blob: 0ec49bcc8ec934f2bb2b828616d6ddfcc114d600 [file] [log] [blame]
<!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 `aio` mod in crate `nix`.">
<meta name="keywords" content="rust, rustlang, rust-lang, aio">
<title>nix::sys::aio - 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'>Module aio</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a></p><script>window.sidebarCurrent = {name: 'aio', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" href=''>aio</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../../src/nix/sys/aio.rs.html#1-314' title='goto source code'>[src]</a></span></h1>
<h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.AioCb.html"
title='struct nix::sys::aio::AioCb'>AioCb</a></td>
<td class='docblock-short'>
<p>The basic structure used by all aio functions. Each <code>aiocb</code> represents one
I/O request.</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.AioCancelStat.html"
title='enum nix::sys::aio::AioCancelStat'>AioCancelStat</a></td>
<td class='docblock-short'>
<p>Return values for <code>AioCb::cancel and aio_cancel_all</code></p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.AioFsyncMode.html"
title='enum nix::sys::aio::AioFsyncMode'>AioFsyncMode</a></td>
<td class='docblock-short'>
<p>Mode for <code>AioCb::fsync</code>. Controls whether only data or both data and
metadata are synced.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.LioMode.html"
title='enum nix::sys::aio::LioMode'>LioMode</a></td>
<td class='docblock-short'>
<p>Mode for <code>lio_listio</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.LioOpcode.html"
title='enum nix::sys::aio::LioOpcode'>LioOpcode</a></td>
<td class='docblock-short'>
<p>When used with <code>lio_listio</code>, determines whether a given <code>aiocb</code> should be
used for a read operation, a write operation, or ignored. Has no effect for
any other aio functions.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.aio_cancel_all.html"
title='fn nix::sys::aio::aio_cancel_all'>aio_cancel_all</a></td>
<td class='docblock-short'>
<p>Cancels outstanding AIO requests. All requests for <code>fd</code> will be cancelled.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.aio_suspend.html"
title='fn nix::sys::aio::aio_suspend'>aio_suspend</a></td>
<td class='docblock-short'>
<p>Suspends the calling process until at least one of the specified <code>AioCb</code>s
has completed, a signal is delivered, or the timeout has passed. If
<code>timeout</code> is <code>None</code>, <code>aio_suspend</code> will block indefinitely.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.lio_listio.html"
title='fn nix::sys::aio::lio_listio'>lio_listio</a></td>
<td class='docblock-short'>
<p>Submits multiple asynchronous I/O requests with a single system call. The
order in which the requests are carried out is not specified.</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>