Rust/ssw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Now a REAL lib

Browse Source
This commit is contained in:
Justine
2023-01-09 19:23:20 +01:00
parent ef46613c71
commit fe9e6f04f5
19014 changed files with 715877 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/rustix/io/close/fn.close.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.close.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.close.html">../../../rustix/io/fn.close.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.close.html" + location.search + location.hash);</script>
</body>
</html>

7
doc/rustix/io/constant.PIPE_BUF.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`PIPE_BUF`—The maximum length at which writes to a pipe are atomic."><meta name="keywords" content="rust, rustlang, rust-lang, PIPE_BUF"><title>PIPE_BUF in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc constant"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Constant <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="constant" href="#">PIPE_BUF</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/pipe.rs.html#30">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust const"><code>pub const PIPE_BUF: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a> = backend::io::types::PIPE_BUF; // 4_096usize</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>PIPE_BUF</code>—The maximum length at which writes to a pipe are atomic.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man7/pipe.7.html">Linux</a></li>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/write.html">POSIX</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

11
doc/rustix/io/context/struct.Borrowing.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/epoll/struct.Borrowing.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/epoll/struct.Borrowing.html">../../../rustix/io/epoll/struct.Borrowing.html</a>...</p>
<script>location.replace("../../../rustix/io/epoll/struct.Borrowing.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/context/struct.Owning.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/epoll/struct.Owning.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/epoll/struct.Owning.html">../../../rustix/io/epoll/struct.Owning.html</a>...</p>
<script>location.replace("../../../rustix/io/epoll/struct.Owning.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/context/struct.Ref.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/epoll/struct.Ref.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/epoll/struct.Ref.html">../../../rustix/io/epoll/struct.Ref.html</a>...</p>
<script>location.replace("../../../rustix/io/epoll/struct.Ref.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/context/trait.Context.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/epoll/trait.Context.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/epoll/trait.Context.html">../../../rustix/io/epoll/trait.Context.html</a>...</p>
<script>location.replace("../../../rustix/io/epoll/trait.Context.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/dup/fn.dup.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.dup.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.dup.html">../../../rustix/io/fn.dup.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.dup.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/dup/fn.dup2.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.dup2.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.dup2.html">../../../rustix/io/fn.dup2.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.dup2.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/dup/fn.dup3.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.dup3.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.dup3.html">../../../rustix/io/fn.dup3.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.dup3.html" + location.search + location.hash);</script>
</body>
</html>

36
doc/rustix/io/enum.SeekFrom.html Normal file
View File

File diff suppressed because one or more lines are too long

59
doc/rustix/io/epoll/index.html Normal file
View File

@ -0,0 +1,59 @@
<!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="epoll support."><meta name="keywords" content="rust, rustlang, rust-lang, epoll"><title>rustix::io::epoll - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module epoll</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../rustix/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../../index.html">rustix</a>::<wbr><a href="../index.html">io</a>::<wbr><a class="mod" href="#">epoll</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/rustix/backend/linux_raw/io/epoll.rs.html#1-404">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>epoll support.</p>
<p>This is an experiment, and it isn’t yet clear whether epoll is the right
level of abstraction at which to introduce safety. But it works fairly well
in simple examples 🙂.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">io_lifetimes::AsFd</span>;
<span class="kw">use</span> <span class="ident">rustix::io::epoll</span>::{<span class="self">self</span>, <span class="ident">Epoll</span>};
<span class="kw">use</span> <span class="ident">rustix::io</span>::{<span class="ident">ioctl_fionbio</span>, <span class="ident">read</span>, <span class="ident">write</span>};
<span class="kw">use</span> <span class="ident">rustix::net</span>::{
<span class="ident">accept</span>, <span class="ident">bind_v4</span>, <span class="ident">listen</span>, <span class="ident">socket</span>, <span class="ident">AddressFamily</span>, <span class="ident">Ipv4Addr</span>, <span class="ident">Protocol</span>, <span class="ident">SocketAddrV4</span>,
<span class="ident">SocketType</span>,
};
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;
<span class="comment">// Create a socket and listen on it.</span>
<span class="kw">let</span> <span class="ident">listen_sock</span> <span class="op">=</span> <span class="ident">socket</span>(<span class="ident">AddressFamily::INET</span>, <span class="ident">SocketType::STREAM</span>, <span class="ident">Protocol::default</span>())<span class="question-mark">?</span>;
<span class="ident">bind_v4</span>(<span class="kw-2">&amp;</span><span class="ident">listen_sock</span>, <span class="kw-2">&amp;</span><span class="ident">SocketAddrV4::new</span>(<span class="ident">Ipv4Addr::LOCALHOST</span>, <span class="number">0</span>))<span class="question-mark">?</span>;
<span class="ident">listen</span>(<span class="kw-2">&amp;</span><span class="ident">listen_sock</span>, <span class="number">1</span>)<span class="question-mark">?</span>;
<span class="comment">// Create an epoll object. Using `Owning` here means the epoll object will</span>
<span class="comment">// take ownership of the file descriptors registered with it.</span>
<span class="kw">let</span> <span class="ident">epoll</span> <span class="op">=</span> <span class="ident">Epoll::new</span>(<span class="ident">epoll::CreateFlags::CLOEXEC</span>, <span class="ident">epoll::Owning::new</span>())<span class="question-mark">?</span>;
<span class="comment">// Remember the socket raw fd, which we use for comparisons only.</span>
<span class="kw">let</span> <span class="ident">raw_listen_sock</span> <span class="op">=</span> <span class="ident">listen_sock</span>.<span class="ident">as_fd</span>().<span class="ident">as_raw_fd</span>();
<span class="comment">// Register the socket with the epoll object.</span>
<span class="ident">epoll</span>.<span class="ident">add</span>(<span class="ident">listen_sock</span>, <span class="ident">epoll::EventFlags::IN</span>)<span class="question-mark">?</span>;
<span class="comment">// Process events.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">event_list</span> <span class="op">=</span> <span class="ident">epoll::EventVec::with_capacity</span>(<span class="number">4</span>);
<span class="kw">loop</span> {
<span class="ident">epoll</span>.<span class="ident">wait</span>(<span class="kw-2">&amp;mut</span> <span class="ident">event_list</span>, <span class="op">-</span><span class="number">1</span>)<span class="question-mark">?</span>;
<span class="kw">for</span> (<span class="ident">_event_flags</span>, <span class="ident">target</span>) <span class="kw">in</span> <span class="kw-2">&amp;</span><span class="ident">event_list</span> {
<span class="kw">if</span> <span class="ident">target</span>.<span class="ident">as_raw_fd</span>() <span class="op">==</span> <span class="ident">raw_listen_sock</span> {
<span class="comment">// Accept a new connection, set it to non-blocking, and</span>
<span class="comment">// register to be notified when it&#39;s ready to write to.</span>
<span class="kw">let</span> <span class="ident">conn_sock</span> <span class="op">=</span> <span class="ident">accept</span>(<span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="ident">target</span>)<span class="question-mark">?</span>;
<span class="ident">ioctl_fionbio</span>(<span class="kw-2">&amp;</span><span class="ident">conn_sock</span>, <span class="bool-val">true</span>)<span class="question-mark">?</span>;
<span class="ident">epoll</span>.<span class="ident">add</span>(<span class="ident">conn_sock</span>, <span class="ident">epoll::EventFlags::OUT</span> <span class="op">|</span> <span class="ident">epoll::EventFlags::ET</span>)<span class="question-mark">?</span>;
} <span class="kw">else</span> {
<span class="comment">// Write a message to the stream and then unregister it.</span>
<span class="ident">write</span>(<span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="ident">target</span>, <span class="string">b&quot;hello\n&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">epoll</span>.<span class="ident">del</span>(<span class="ident">target</span>)<span class="question-mark">?</span>;
}
}
}</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Borrowing.html" title="rustix::io::epoll::Borrowing struct">Borrowing</a></div><div class="item-right docblock-short"><p>A type implementing <a href="trait.Context.html" title="Context"><code>Context</code></a> where the <code>Data</code> type is <code>BorrowedFd&lt;'a&gt;</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CreateFlags.html" title="rustix::io::epoll::CreateFlags struct">CreateFlags</a></div><div class="item-right docblock-short"><p><code>EPOLL_*</code> for use with <a href="struct.Epoll.html#method.new" title="Epoll::new"><code>Epoll::new</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Epoll.html" title="rustix::io::epoll::Epoll struct">Epoll</a></div><div class="item-right docblock-short"><p>An “epoll”, an interface to an OS object allowing one to repeatedly wait
for events from a set of file descriptors efficiently.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EventFlags.html" title="rustix::io::epoll::EventFlags struct">EventFlags</a></div><div class="item-right docblock-short"><p><code>EPOLL*</code> for use with <a href="struct.Epoll.html#method.add" title="Epoll::add"><code>Epoll::add</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EventVec.html" title="rustix::io::epoll::EventVec struct">EventVec</a></div><div class="item-right docblock-short"><p>A vector of <code>Event</code>s, plus context for interpreting them.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="rustix::io::epoll::Iter struct">Iter</a></div><div class="item-right docblock-short"><p>An iterator over the <code>Event</code>s in an <code>EventVec</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Owning.html" title="rustix::io::epoll::Owning struct">Owning</a></div><div class="item-right docblock-short"><p>A type implementing <a href="trait.Context.html" title="Context"><code>Context</code></a> where the <code>Data</code> type is <code>T</code>, a type
implementing <code>From&lt;OwnedFd&gt;</code> and <code>From&lt;T&gt; for OwnedFd</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Ref.html" title="rustix::io::epoll::Ref struct">Ref</a></div><div class="item-right docblock-short"><p>A reference to a <code>T</code>.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Context.html" title="rustix::io::epoll::Context trait">Context</a></div><div class="item-right docblock-short"><p>A trait for data stored within an <a href="struct.Epoll.html"><code>Epoll</code></a> instance.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

1
doc/rustix/io/epoll/sidebar-items.js Normal file
View File

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":[["Borrowing","A type implementing [`Context`] where the `Data` type is `BorrowedFd<'a>`."],["CreateFlags","`EPOLL_*` for use with [`Epoll::new`]."],["Epoll","An “epoll”, an interface to an OS object allowing one to repeatedly wait for events from a set of file descriptors efficiently."],["EventFlags","`EPOLL*` for use with [`Epoll::add`]."],["EventVec","A vector of `Event`s, plus context for interpreting them."],["Iter","An iterator over the `Event`s in an `EventVec`."],["Owning","A type implementing [`Context`] where the `Data` type is `T`, a type implementing `From<OwnedFd>` and `From<T> for OwnedFd`."],["Ref","A reference to a `T`."]],"trait":[["Context","A trait for data stored within an `Epoll` instance."]]};

20
doc/rustix/io/epoll/struct.Borrowing.html Normal file
View File

File diff suppressed because one or more lines are too long

116
doc/rustix/io/epoll/struct.CreateFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

62
doc/rustix/io/epoll/struct.Epoll.html Normal file
View File

File diff suppressed because one or more lines are too long

125
doc/rustix/io/epoll/struct.EventFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

25
doc/rustix/io/epoll/struct.EventVec.html Normal file
View File

File diff suppressed because one or more lines are too long

129
doc/rustix/io/epoll/struct.Iter.html Normal file
View File

File diff suppressed because one or more lines are too long

24
doc/rustix/io/epoll/struct.Owning.html Normal file
View File

File diff suppressed because one or more lines are too long

16
doc/rustix/io/epoll/struct.Ref.html Normal file
View File

File diff suppressed because one or more lines are too long

20
doc/rustix/io/epoll/trait.Context.html Normal file
View File

@ -0,0 +1,20 @@
<!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="A trait for data stored within an `Epoll` instance."><meta name="keywords" content="rust, rustlang, rust-lang, Context"><title>Context in rustix::io::epoll - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><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="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Context</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.Data">Data</a></li><li><a href="#associatedtype.Target">Target</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.acquire">acquire</a></li><li><a href="#tymethod.decode">decode</a></li><li><a href="#tymethod.encode">encode</a></li><li><a href="#tymethod.release">release</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In rustix::io::epoll</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../rustix/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">rustix</a>::<wbr><a href="../index.html">io</a>::<wbr><a href="index.html">epoll</a>::<wbr><a class="trait" href="#">Context</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/rustix/io/context.rs.html#50-74">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Context {
type <a href="#associatedtype.Data" class="associatedtype">Data</a>;
type <a href="#associatedtype.Target" class="associatedtype">Target</a>: <a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>;
fn <a href="#tymethod.acquire" class="fnname">acquire</a>&lt;'call&gt;(&amp;self, data: Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>) -&gt; <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.encode" class="fnname">encode</a>(&amp;self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>;
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.decode" class="fnname">decode</a>&lt;'call&gt;(&amp;self, raw: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -&gt; <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.release" class="fnname">release</a>(&amp;self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;) -&gt; Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for data stored within an <a href="struct.Epoll.html"><code>Epoll</code></a> instance.</p>
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Data" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#52">source</a></div><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a></h4></div></summary><div class="docblock"><p>The type of an element owned by this context.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Target" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#55">source</a></div><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a>: <a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a></h4></div></summary><div class="docblock"><p>The type of a value used to refer to an element owned by this context.</p>
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.acquire" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#58">source</a></div><h4 class="code-header">fn <a href="#tymethod.acquire" class="fnname">acquire</a>&lt;'call&gt;(&amp;self, data: Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a>) -&gt; <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;</h4></div></summary><div class="docblock"><p>Assume ownership of <code>data</code>, and returning a <code>Target</code>.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.encode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#62">source</a></div><h4 class="code-header">fn <a href="#tymethod.encode" class="fnname">encode</a>(&amp;self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a></h4></div></summary><div class="docblock"><p>Encode <code>target</code> as a <code>u64</code>. The only requirement on this value is that
it be decodable by <code>decode</code>.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.decode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#70">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.decode" class="fnname">decode</a>&lt;'call&gt;(&amp;self, raw: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -&gt; <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'call, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;</h4></div></summary><div class="docblock"><p>Decode <code>raw</code>, which is a value encoded by <code>encode</code>, into a <code>Target</code>.</p>
<h5 id="safety"><a href="#safety">Safety</a></h5>
<p><code>raw</code> must be a <code>u64</code> value returned from <code>encode</code>, from the same
context, and within the context’s lifetime.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.release" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#73">source</a></div><h4 class="code-header">fn <a href="#tymethod.release" class="fnname">release</a>(&amp;self, target: <a class="struct" href="struct.Ref.html" title="struct rustix::io::epoll::Ref">Ref</a>&lt;'_, Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Target" title="type rustix::io::epoll::Context::Target">Target</a>&gt;) -&gt; Self::<a class="associatedtype" href="trait.Context.html#associatedtype.Data" title="type rustix::io::epoll::Context::Data">Data</a></h4></div></summary><div class="docblock"><p>Release ownership of the value referred to by <code>target</code> and return it.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Context-for-Borrowing%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#81-104">source</a></span><a href="#impl-Context-for-Borrowing%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;'a&gt; <a class="trait" href="trait.Context.html" title="trait rustix::io::epoll::Context">Context</a> for <a class="struct" href="struct.Borrowing.html" title="struct rustix::io::epoll::Borrowing">Borrowing</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Data-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Data-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'a&gt;</h4></section><section id="associatedtype.Target-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'a&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Context-for-Owning%3C%27context%2C%20T%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/rustix/io/context.rs.html#129-163">source</a></span><a href="#impl-Context-for-Owning%3C%27context%2C%20T%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;'context, T:&nbsp;<a class="trait" href="../../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt; + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="../../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt;&gt; <a class="trait" href="trait.Context.html" title="trait rustix::io::epoll::Context">Context</a> for <a class="struct" href="struct.Owning.html" title="struct rustix::io::epoll::Owning">Owning</a>&lt;'context, T&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Data-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Data-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a> = T</h4></section><section id="associatedtype.Target-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'context&gt;</h4></section></div></details></div><script type="text/javascript" src="../../../implementors/rustix/io/context/trait.Context.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

11
doc/rustix/io/errno/fn.retry_on_intr.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.retry_on_intr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.retry_on_intr.html">../../../rustix/io/fn.retry_on_intr.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.retry_on_intr.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/errno/type.Result.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/type.Result.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/type.Result.html">../../../rustix/io/type.Result.html</a>...</p>
<script>location.replace("../../../rustix/io/type.Result.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/eventfd/fn.eventfd.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.eventfd.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.eventfd.html">../../../rustix/io/fn.eventfd.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.eventfd.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/fcntl/fn.fcntl_dupfd_cloexec.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.fcntl_dupfd_cloexec.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.fcntl_dupfd_cloexec.html">../../../rustix/io/fn.fcntl_dupfd_cloexec.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.fcntl_dupfd_cloexec.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/fcntl/fn.fcntl_getfd.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.fcntl_getfd.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.fcntl_getfd.html">../../../rustix/io/fn.fcntl_getfd.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.fcntl_getfd.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/fcntl/fn.fcntl_setfd.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.fcntl_setfd.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.fcntl_setfd.html">../../../rustix/io/fn.fcntl_setfd.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.fcntl_setfd.html" + location.search + location.hash);</script>
</body>
</html>

18
doc/rustix/io/fn.close.html Normal file
View File

@ -0,0 +1,18 @@
<!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="`close(raw_fd)`—Closes a `RawFd` directly."><meta name="keywords" content="rust, rustlang, rust-lang, close"><title>close in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">close</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/close.rs.html#39-41">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub unsafe fn close(raw_fd: <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a>)</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>close(raw_fd)</code>—Closes a <code>RawFd</code> directly.</p>
<p>Most users won’t need to use this, as <code>OwnedFd</code> automatically closes its
file descriptor on <code>Drop</code>.</p>
<p>This function does not return a <code>Result</code>, as it is the <a href="https://lwn.net/Articles/576518/">responsibility</a> of
filesystem designers to not return errors from <code>close</code>. Users who chose to
use NFS or similar filesystems should take care to monitor for problems
externally.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/close.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/close.2.html#//apple_ref/doc/man/2/close">Apple</a></li>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-closesocket">Winsock2</a></li>
</ul>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This function takes a <code>RawFd</code>, which must be valid before the call, and is
not valid after the call.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

14
doc/rustix/io/fn.dup.html Normal file
View File

@ -0,0 +1,14 @@
<!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="`dup(fd)`—Creates a new `OwnedFd` instance that shares the same underlying file description as `fd`."><meta name="keywords" content="rust, rustlang, rust-lang, dup"><title>dup in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">dup</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/dup.rs.html#32-34">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn dup&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>dup(fd)</code>—Creates a new <code>OwnedFd</code> instance that shares the same
underlying <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> as <code>fd</code>.</p>
<p>This function does not set the <code>O_CLOEXEC</code> flag. To do a <code>dup</code> that does
set <code>O_CLOEXEC</code>, use <a href="fn.fcntl_dupfd_cloexec.html"><code>fcntl_dupfd_cloexec</code></a>.</p>
<p>POSIX guarantees that <code>dup</code> will use the lowest unused file descriptor,
however it is not safe in general to rely on this, as file descriptors may
be unexpectedly allocated on other threads or in libraries.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/dup.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/dup.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/dup.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

15
doc/rustix/io/fn.dup2.html Normal file
View File

@ -0,0 +1,15 @@
<!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="`dup2(fd, new)`—Changes the file description of a file descriptor."><meta name="keywords" content="rust, rustlang, rust-lang, dup2"><title>dup2 in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">dup2</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/dup.rs.html#59-61">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn dup2&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, new: &amp;mut <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>dup2(fd, new)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file descriptor.</p>
<p><code>dup2</code> conceptually closes <code>new</code> and then sets the file description for
<code>new</code> to be the same as the one for <code>fd</code>. This is a very unusual operation,
and should only be used on file descriptors where you know how <code>new</code> will
be subsequently used.</p>
<p>This function does not set the <code>O_CLOEXEC</code> flag. To do a <code>dup2</code> that does
set <code>O_CLOEXEC</code>, use <a href="fn.dup3.html" title="dup3"><code>dup3</code></a> with <a href="struct.DupFlags.html#associatedconstant.CLOEXEC" title="DupFlags::CLOEXEC"><code>DupFlags::CLOEXEC</code></a> on platforms which
support it, or <a href="fn.fcntl_dupfd_cloexec.html"><code>fcntl_dupfd_cloexec</code></a></p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/dup2.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/dup2.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/dup2.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

11
doc/rustix/io/fn.dup3.html Normal file
View File

@ -0,0 +1,11 @@
<!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="`dup3(fd, new, flags)`—Changes the file description of a file descriptor, with flags."><meta name="keywords" content="rust, rustlang, rust-lang, dup3"><title>dup3 in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">dup3</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/dup.rs.html#78-80">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn dup3&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, new: &amp;mut <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>, flags: <a class="struct" href="struct.DupFlags.html" title="struct rustix::io::DupFlags">DupFlags</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>dup3(fd, new, flags)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file
descriptor, with flags.</p>
<p><code>dup3</code> is the same as <a href="fn.dup2.html" title="dup2"><code>dup2</code></a> but adds an additional flags operand, and it
fails in the case that <code>fd</code> and <code>new</code> have the same file descriptor value.
This additional difference is the reason this function isn’t named
<code>dup2_with</code>.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/dup3.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.eventfd.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`eventfd(initval, flags)`—Creates a file descriptor for event notification."><meta name="keywords" content="rust, rustlang, rust-lang, eventfd"><title>eventfd in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">eventfd</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/eventfd.rs.html#14-16">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn eventfd(initval: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u32.html">u32</a>, flags: <a class="struct" href="struct.EventfdFlags.html" title="struct rustix::io::EventfdFlags">EventfdFlags</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>eventfd(initval, flags)</code>—Creates a file descriptor for event
notification.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/eventfd.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

13
doc/rustix/io/fn.fcntl_dupfd_cloexec.html Normal file
View File

@ -0,0 +1,13 @@
<!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="`fcntl(fd, F_DUPFD_CLOEXEC)`—Creates a new `OwnedFd` instance, with value at least `min`, that has `O_CLOEXEC` set and that shares the same underlying [file description] as `fd`."><meta name="keywords" content="rust, rustlang, rust-lang, fcntl_dupfd_cloexec"><title>fcntl_dupfd_cloexec in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">fcntl_dupfd_cloexec</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/fcntl.rs.html#62-64">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn fcntl_dupfd_cloexec&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, min: <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>fcntl(fd, F_DUPFD_CLOEXEC)</code>—Creates a new <code>OwnedFd</code> instance, with value
at least <code>min</code>, that has <code>O_CLOEXEC</code> set and that shares the same
underlying [file description] as <code>fd</code>.</p>
<p>POSIX guarantees that <code>F_DUPFD_CLOEXEC</code> will use the lowest unused file
descriptor which is at least <code>min</code>, however it is not safe in general to
rely on this, as file descriptors may be unexpectedly allocated on other
threads or in libraries.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.fcntl_getfd.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`fcntl(fd, F_GETFD)`—Returns a file descriptor’s flags."><meta name="keywords" content="rust, rustlang, rust-lang, fcntl_getfd"><title>fcntl_getfd in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">fcntl_getfd</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/fcntl.rs.html#26-28">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn fcntl_getfd&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="struct" href="struct.FdFlags.html" title="struct rustix::io::FdFlags">FdFlags</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>fcntl(fd, F_GETFD)</code>—Returns a file descriptor’s flags.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.fcntl_setfd.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`fcntl(fd, F_SETFD, flags)`—Sets a file descriptor’s flags."><meta name="keywords" content="rust, rustlang, rust-lang, fcntl_setfd"><title>fcntl_setfd in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">fcntl_setfd</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/fcntl.rs.html#40-42">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn fcntl_setfd&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, flags: <a class="struct" href="struct.FdFlags.html" title="struct rustix::io::FdFlags">FdFlags</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>fcntl(fd, F_SETFD, flags)</code>—Sets a file descriptor’s flags.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

2
doc/rustix/io/fn.ioctl_blkpbszget.html Normal file
View File

@ -0,0 +1,2 @@
<!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="`ioctl(fd, BLKPBSZGET)`—Returns the physical block size of a block device."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_blkpbszget"><title>ioctl_blkpbszget in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_blkpbszget</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#97-99">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_blkpbszget&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u32.html">u32</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, BLKPBSZGET)</code>—Returns the physical block size of a block device.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

2
doc/rustix/io/fn.ioctl_blksszget.html Normal file
View File

@ -0,0 +1,2 @@
<!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="`ioctl(fd, BLKSSZGET)`—Returns the logical block size of a block device."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_blksszget"><title>ioctl_blksszget in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_blksszget</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#89-91">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_blksszget&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u32.html">u32</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, BLKSSZGET)</code>—Returns the logical block size of a block device.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.ioctl_fionbio.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`ioctl(fd, FIONBIO, &amp;value)`—Enables or disables non-blocking mode."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_fionbio"><title>ioctl_fionbio in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_fionbio</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#63-65">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_fionbio&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, FIONBIO, &amp;value)</code>—Enables or disables non-blocking mode.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/ioctl.2.html">Linux</a></li>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/winsock/winsock-ioctls#unix-ioctl-codes">Winsock2</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

9
doc/rustix/io/fn.ioctl_fionread.html Normal file
View File

@ -0,0 +1,9 @@
<!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="`ioctl(fd, FIONREAD)`—Returns the number of bytes ready to be read."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_fionread"><title>ioctl_fionread in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_fionread</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#81-83">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_fionread&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, FIONREAD)</code>—Returns the number of bytes ready to be read.</p>
<p>The result of this function gets silently coerced into a C <code>int</code>
by the OS, so it may contain a wrapped value.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/ioctl_tty.2.html">Linux</a></li>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/winsock/winsock-ioctls#unix-ioctl-codes">Winsock2</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

6
doc/rustix/io/fn.ioctl_tiocexcl.html Normal file
View File

@ -0,0 +1,6 @@
<!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="`ioctl(fd, TIOCEXCL)`—Enables exclusive mode on a terminal."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_tiocexcl"><title>ioctl_tiocexcl in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_tiocexcl</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#18-20">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_tiocexcl&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, TIOCEXCL)</code>—Enables exclusive mode on a terminal.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man4/tty_ioctl.4.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

6
doc/rustix/io/fn.ioctl_tiocnxcl.html Normal file
View File

@ -0,0 +1,6 @@
<!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="`ioctl(fd, TIOCNXCL)`—Disables exclusive mode on a terminal."><meta name="keywords" content="rust, rustlang, rust-lang, ioctl_tiocnxcl"><title>ioctl_tiocnxcl in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">ioctl_tiocnxcl</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/ioctl.rs.html#31-33">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn ioctl_tiocnxcl&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ioctl(fd, TIOCNXCL)</code>—Disables exclusive mode on a terminal.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man4/tty_ioctl.4.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

9
doc/rustix/io/fn.pipe.html Normal file
View File

@ -0,0 +1,9 @@
<!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="`pipe()`—Creates a pipe."><meta name="keywords" content="rust, rustlang, rust-lang, pipe"><title>pipe in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pipe</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/pipe.rs.html#44-46">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pipe() -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;(<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>, <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>)&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pipe()</code>—Creates a pipe.</p>
<p>This function creates a pipe and returns two file descriptors, for the
reading and writing ends of the pipe, respectively.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/pipe.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/pipe.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.pipe_with.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`pipe2(flags)`—Creates a pipe, with flags."><meta name="keywords" content="rust, rustlang, rust-lang, pipe_with"><title>pipe_with in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pipe_with</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/pipe.rs.html#65-67">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pipe_with(flags: <a class="struct" href="struct.PipeFlags.html" title="struct rustix::io::PipeFlags">PipeFlags</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;(<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>, <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>)&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pipe2(flags)</code>—Creates a pipe, with flags.</p>
<p>This function creates a pipe and returns two file descriptors, for the
reading and writing ends of the pipe, respectively.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/pipe2.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

9
doc/rustix/io/fn.poll.html Normal file
View File

@ -0,0 +1,9 @@
<!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="`poll(self.fds, timeout)`"><meta name="keywords" content="rust, rustlang, rust-lang, poll"><title>poll in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">poll</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/poll.rs.html#18-20">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn poll(fds: &amp;mut [<a class="struct" href="struct.PollFd.html" title="struct rustix::io::PollFd">PollFd</a>&lt;'_&gt;], timeout: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>poll(self.fds, timeout)</code></p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/poll.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/poll.2.html">Apple</a></li>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsapoll">Winsock2</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.pread.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`pread(fd, buf, offset)`—Reads from a file at a given position."><meta name="keywords" content="rust, rustlang, rust-lang, pread"><title>pread in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pread</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#59-61">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pread&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>], offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pread(fd, buf, offset)</code>—Reads from a file at a given position.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/pread.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/pread.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/pread.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.preadv.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`preadv(fd, bufs, offset)`—Reads from a file at a given position into multiple buffers."><meta name="keywords" content="rust, rustlang, rust-lang, preadv"><title>preadv in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">preadv</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#121-123">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn preadv&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;fd: Fd,<br>&nbsp;&nbsp;&nbsp;&nbsp;bufs: &amp;mut [<a class="struct" href="struct.IoSliceMut.html" title="struct rustix::io::IoSliceMut">IoSliceMut</a>&lt;'_&gt;],<br>&nbsp;&nbsp;&nbsp;&nbsp;offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a><br>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>preadv(fd, bufs, offset)</code>—Reads from a file at a given position into
multiple buffers.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/preadv.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.preadv2.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`preadv2(fd, bufs, offset, flags)`—Reads data, with several options."><meta name="keywords" content="rust, rustlang, rust-lang, preadv2"><title>preadv2 in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">preadv2</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#152-159">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn preadv2&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;fd: Fd,<br>&nbsp;&nbsp;&nbsp;&nbsp;bufs: &amp;mut [<a class="struct" href="struct.IoSliceMut.html" title="struct rustix::io::IoSliceMut">IoSliceMut</a>&lt;'_&gt;],<br>&nbsp;&nbsp;&nbsp;&nbsp;offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="struct.ReadWriteFlags.html" title="struct rustix::io::ReadWriteFlags">ReadWriteFlags</a><br>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>preadv2(fd, bufs, offset, flags)</code>—Reads data, with several options.</p>
<p>An <code>offset</code> of <code>u64::MAX</code> means to use and update the current file offset.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/preadv2.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

11
doc/rustix/io/fn.pwrite.html Normal file
View File

@ -0,0 +1,11 @@
<!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="`pwrite(fd, bufs)`—Writes to a file at a given position."><meta name="keywords" content="rust, rustlang, rust-lang, pwrite"><title>pwrite in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pwrite</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#78-80">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pwrite&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>], offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pwrite(fd, bufs)</code>—Writes to a file at a given position.</p>
<p>Contrary to POSIX, on many popular platforms including Linux and FreeBSD,
if the file is opened in append mode, this ignores the offset appends the
data to the end of the file.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/pwrite.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/pwrite.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/pwrite.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

10
doc/rustix/io/fn.pwritev.html Normal file
View File

@ -0,0 +1,10 @@
<!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="`pwritev(fd, bufs, offset)`—Writes to a file at a given position from multiple buffers."><meta name="keywords" content="rust, rustlang, rust-lang, pwritev"><title>pwritev in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pwritev</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#138-140">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pwritev&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;fd: Fd,<br>&nbsp;&nbsp;&nbsp;&nbsp;bufs: &amp;[<a class="struct" href="struct.IoSlice.html" title="struct rustix::io::IoSlice">IoSlice</a>&lt;'_&gt;],<br>&nbsp;&nbsp;&nbsp;&nbsp;offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a><br>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pwritev(fd, bufs, offset)</code>—Writes to a file at a given position from
multiple buffers.</p>
<p>Contrary to POSIX, on many popular platforms including Linux and FreeBSD,
if the file is opened in append mode, this ignores the offset appends the
data to the end of the file.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/pwritev.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

7
doc/rustix/io/fn.pwritev2.html Normal file
View File

@ -0,0 +1,7 @@
<!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="`pwritev2(fd, bufs, offset, flags)`—Writes data, with several options."><meta name="keywords" content="rust, rustlang, rust-lang, pwritev2"><title>pwritev2 in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">pwritev2</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#171-178">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn pwritev2&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;fd: Fd,<br>&nbsp;&nbsp;&nbsp;&nbsp;bufs: &amp;[<a class="struct" href="struct.IoSlice.html" title="struct rustix::io::IoSlice">IoSlice</a>&lt;'_&gt;],<br>&nbsp;&nbsp;&nbsp;&nbsp;offset: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u64.html">u64</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="struct.ReadWriteFlags.html" title="struct rustix::io::ReadWriteFlags">ReadWriteFlags</a><br>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>pwritev2(fd, bufs, offset, flags)</code>—Writes data, with several options.</p>
<p>An <code>offset</code> of <code>u64::MAX</code> means to use and update the current file offset.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/pwritev2.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

10
doc/rustix/io/fn.raw_stderr.html Normal file
View File

@ -0,0 +1,10 @@
<!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="`STDERR_FILENO`—Standard error, raw."><meta name="keywords" content="rust, rustlang, rust-lang, raw_stderr"><title>raw_stderr in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">raw_stderr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#252-254">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const fn raw_stderr() -&gt; <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDERR_FILENO</code>—Standard error, raw.</p>
<p>This is similar to <a href="fn.stderr.html" title="stderr"><code>stderr</code></a>, however it returns a <code>RawFd</code>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stderr.html" title="stderr"><code>stderr</code></a>.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stderr.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stderr.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

10
doc/rustix/io/fn.raw_stdin.html Normal file
View File

@ -0,0 +1,10 @@
<!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="`STDIN_FILENO`—Standard input, raw."><meta name="keywords" content="rust, rustlang, rust-lang, raw_stdin"><title>raw_stdin in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">raw_stdin</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#212-214">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const fn raw_stdin() -&gt; <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDIN_FILENO</code>—Standard input, raw.</p>
<p>This is similar to <a href="fn.stdin.html" title="stdin"><code>stdin</code></a>, however it returns a <code>RawFd</code>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stdin.html" title="stdin"><code>stdin</code></a>.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdin.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdin.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

10
doc/rustix/io/fn.raw_stdout.html Normal file
View File

@ -0,0 +1,10 @@
<!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="`STDOUT_FILENO`—Standard output, raw."><meta name="keywords" content="rust, rustlang, rust-lang, raw_stdout"><title>raw_stdout in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">raw_stdout</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#232-234">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const fn raw_stdout() -&gt; <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDOUT_FILENO</code>—Standard output, raw.</p>
<p>This is similar to <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>, however it returns a <code>RawFd</code>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdout.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdout.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.read.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`read(fd, buf)`—Reads from a stream."><meta name="keywords" content="rust, rustlang, rust-lang, read"><title>read in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">read</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#29-31">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn read&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>read(fd, buf)</code>—Reads from a stream.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/read.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/read.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/read.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.readv.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`readv(fd, bufs)`—Reads from a stream into multiple buffers."><meta name="keywords" content="rust, rustlang, rust-lang, readv"><title>readv in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">readv</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#93-95">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn readv&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, bufs: &amp;mut [<a class="struct" href="struct.IoSliceMut.html" title="struct rustix::io::IoSliceMut">IoSliceMut</a>&lt;'_&gt;]) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>readv(fd, bufs)</code>—Reads from a stream into multiple buffers.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/readv.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/readv.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/readv.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

2
doc/rustix/io/fn.retry_on_intr.html Normal file
View File

@ -0,0 +1,2 @@
<!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="Call `f` until it either succeeds or fails other than [`Errno::INTR`]."><meta name="keywords" content="rust, rustlang, rust-lang, retry_on_intr"><title>retry_on_intr in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">retry_on_intr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/errno.rs.html#78-85">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn retry_on_intr&lt;T, F:&nbsp;<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;T&gt;&gt;(f: F) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;T&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Call <code>f</code> until it either succeeds or fails other than <a href="struct.Errno.html#associatedconstant.INTR" title="Errno::INTR"><code>Errno::INTR</code></a>.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

15
doc/rustix/io/fn.splice.html Normal file
View File

File diff suppressed because one or more lines are too long

18
doc/rustix/io/fn.stderr.html Normal file
View File

@ -0,0 +1,18 @@
<!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="`STDERR_FILENO`—Standard error, borrowed."><meta name="keywords" content="rust, rustlang, rust-lang, stderr"><title>stderr in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">stderr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#162-164">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const unsafe fn stderr() -&gt; <a class="struct" href="../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'static&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDERR_FILENO</code>—Standard error, borrowed.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This function must be called from code which knows how the process’
standard error is being used. Often, this will be the <code>main</code> function or
code that knows its relationship with the <code>main</code> function.</p>
<p>The stderr file descriptor can be closed, potentially on other threads, in
which case the file descriptor index value could be dynamically reused for
other purposes, potentially on different threads.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>Stderr could be redirected to arbitrary output sinks, and unless one
knows how the process’ standard error is being used, one could unexpectedly
inject bytes into a stream being written by another part of the process.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stderr.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stderr.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

18
doc/rustix/io/fn.stdin.html Normal file
View File

@ -0,0 +1,18 @@
<!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="`STDIN_FILENO`—Standard input, borrowed."><meta name="keywords" content="rust, rustlang, rust-lang, stdin"><title>stdin in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">stdin</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#41-43">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const unsafe fn stdin() -&gt; <a class="struct" href="../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'static&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDIN_FILENO</code>—Standard input, borrowed.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This function must be called from code which knows how the process’
standard input is being used. Often, this will be the <code>main</code> function or
code that knows its relationship with the <code>main</code> function.</p>
<p>The stdin file descriptor can be closed, potentially on other threads, in
which case the file descriptor index value could be dynamically reused for
other purposes, potentially on different threads.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>Stdin could be redirected from arbitrary input sources, and unless one
knows how the process’ standard input is being used, one could consume
bytes that are expected to be consumed by other parts of the process.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdin.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdin.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

19
doc/rustix/io/fn.stdout.html Normal file
View File

@ -0,0 +1,19 @@
<!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="`STDOUT_FILENO`—Standard output, borrowed."><meta name="keywords" content="rust, rustlang, rust-lang, stdout"><title>stdout in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">stdout</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#102-104">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const unsafe fn stdout() -&gt; <a class="struct" href="../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'static&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDOUT_FILENO</code>—Standard output, borrowed.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This function must be called from code which knows how the process’
standard output is being used. Often, this will be the <code>main</code> function or
code that knows its relationship with the <code>main</code> function.</p>
<p>The stdout file descriptor can be closed, potentially on other threads, in
which case the file descriptor index value could be dynamically reused for
other purposes, potentially on different threads.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>Stdout could be redirected to arbitrary output sinks, and unless one
knows how the process’ standard output is being used, one could
unexpectedly inject bytes into a stream being written by another part of
the process.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdout.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdout.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

17
doc/rustix/io/fn.take_stderr.html Normal file
View File

@ -0,0 +1,17 @@
<!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="`STDERR_FILENO`—Standard error, owned."><meta name="keywords" content="rust, rustlang, rust-lang, take_stderr"><title>take_stderr in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">take_stderr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#192-194">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub unsafe fn take_stderr() -&gt; <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDERR_FILENO</code>—Standard error, owned.</p>
<p>This is similar to <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>, however it returns an <code>OwnedFd</code> which closes
standard output when it is dropped.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This is unsafe for the same reasons as <a href="fn.stderr.html" title="stderr"><code>stderr</code></a>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stderr.html" title="stderr"><code>stderr</code></a>.</p>
<p>And, when the <code>OwnedFd</code> is dropped, subsequent newly created file
descriptors may unknowingly reuse the stderr file descriptor number, which
may break common assumptions, so it should typically only be dropped at the
end of a program when no more file descriptors will be created.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stderr.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stderr.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

17
doc/rustix/io/fn.take_stdin.html Normal file
View File

@ -0,0 +1,17 @@
<!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="`STDIN_FILENO`—Standard input, owned."><meta name="keywords" content="rust, rustlang, rust-lang, take_stdin"><title>take_stdin in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">take_stdin</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#71-73">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub unsafe fn take_stdin() -&gt; <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDIN_FILENO</code>—Standard input, owned.</p>
<p>This is similar to <a href="fn.stdin.html" title="stdin"><code>stdin</code></a>, however it returns an <code>OwnedFd</code> which closes
standard input when it is dropped.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This is unsafe for the same reasons as <a href="fn.stdin.html" title="stdin"><code>stdin</code></a>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stdin.html" title="stdin"><code>stdin</code></a>.</p>
<p>And, when the <code>OwnedFd</code> is dropped, subsequent newly created file
descriptors may unknowingly reuse the stdin file descriptor number, which
may break common assumptions, so it should typically only be dropped at the
end of a program when no more file descriptors will be created.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdin.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdin.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

17
doc/rustix/io/fn.take_stdout.html Normal file
View File

@ -0,0 +1,17 @@
<!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="`STDOUT_FILENO`—Standard output, owned."><meta name="keywords" content="rust, rustlang, rust-lang, take_stdout"><title>take_stdout in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">take_stdout</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#132-134">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub unsafe fn take_stdout() -&gt; <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDOUT_FILENO</code>—Standard output, owned.</p>
<p>This is similar to <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>, however it returns an <code>OwnedFd</code> which closes
standard output when it is dropped.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>This is unsafe for the same reasons as <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>.</p>
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
<p>This has the same hazards as <a href="fn.stdout.html" title="stdout"><code>stdout</code></a>.</p>
<p>And, when the <code>OwnedFd</code> is dropped, subsequent newly created file
descriptors may unknowingly reuse the stdout file descriptor number, which
may break common assumptions, so it should typically only be dropped at the
end of a program when no more file descriptors will be created.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdout.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdout.3.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

17
doc/rustix/io/fn.vmsplice.html Normal file
View File

@ -0,0 +1,17 @@
<!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="`vmsplice(fd, bufs, flags)`—Transfer data between memory and a pipe."><meta name="keywords" content="rust, rustlang, rust-lang, vmsplice"><title>vmsplice in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">vmsplice</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/pipe.rs.html#124-130">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub unsafe fn vmsplice&lt;PipeFd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;fd: PipeFd,<br>&nbsp;&nbsp;&nbsp;&nbsp;bufs: &amp;[<a class="struct" href="struct.IoSliceRaw.html" title="struct rustix::io::IoSliceRaw">IoSliceRaw</a>&lt;'_&gt;],<br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="struct.SpliceFlags.html" title="struct rustix::io::SpliceFlags">SpliceFlags</a><br>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>vmsplice(fd, bufs, flags)</code>—Transfer data between memory and a pipe.</p>
<p>If <code>fd</code> is the write end of the pipe,
the function maps the memory pointer at by <code>bufs</code> to the pipe.</p>
<p>If <code>fd</code> is the read end of the pipe,
the function writes data from the pipe to said memory.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>If the memory must not be mutated (such as when <code>bufs</code> were originally immutable slices),
it is up to the caller to ensure that the write end of the pipe is placed in <code>fd</code>.</p>
<p>Additionally if <code>SpliceFlags::GIFT</code> is set, the caller must also ensure
that the contents of <code>bufs</code> in never modified following the call,
and that all of the pointers in <code>bufs</code> are page aligned,
and the lengths are multiples of a page size in bytes.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/vmsplice.2.html">Linux</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.write.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`write(fd, buf)`—Writes to a stream."><meta name="keywords" content="rust, rustlang, rust-lang, write"><title>write in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">write</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#44-46">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn write&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>write(fd, buf)</code>—Writes to a stream.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/write.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/write.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/write.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

8
doc/rustix/io/fn.writev.html Normal file
View File

@ -0,0 +1,8 @@
<!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="`writev(fd, bufs)`—Writes to a stream from multiple buffers."><meta name="keywords" content="rust, rustlang, rust-lang, writev"><title>writev in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">writev</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/read_write.rs.html#108-110">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn writev&lt;Fd:&nbsp;<a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, bufs: &amp;[<a class="struct" href="struct.IoSlice.html" title="struct rustix::io::IoSlice">IoSlice</a>&lt;'_&gt;]) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>writev(fd, bufs)</code>—Writes to a stream from multiple buffers.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/writev.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/writev.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/writev.2.html">Apple</a></li>
</ul>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

67
doc/rustix/io/index.html Normal file
View File

@ -0,0 +1,67 @@
<!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="I/O operations."><meta name="keywords" content="rust, rustlang, rust-lang, io"><title>rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module io</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">rustix</a>::<wbr><a class="mod" href="#">io</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/mod.rs.html#1-99">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>I/O operations.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="epoll/index.html" title="rustix::io::epoll mod">epoll</a></div><div class="item-right docblock-short"><p>epoll support.</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DupFlags.html" title="rustix::io::DupFlags struct">DupFlags</a></div><div class="item-right docblock-short"><p><code>O_*</code> constants for use with <a href="fn.dup2.html"><code>dup2</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Errno.html" title="rustix::io::Errno struct">Errno</a></div><div class="item-right docblock-short"><p>The error type for <code>rustix</code> APIs.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EventfdFlags.html" title="rustix::io::EventfdFlags struct">EventfdFlags</a></div><div class="item-right docblock-short"><p><code>EFD_*</code> flags for use with <a href="fn.eventfd.html"><code>eventfd</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FdFlags.html" title="rustix::io::FdFlags struct">FdFlags</a></div><div class="item-right docblock-short"><p><code>FD_*</code> constants for use with <a href="fn.fcntl_getfd.html"><code>fcntl_getfd</code></a> and <a href="fn.fcntl_setfd.html"><code>fcntl_setfd</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IoSlice.html" title="rustix::io::IoSlice struct">IoSlice</a></div><div class="item-right docblock-short"><p>A buffer type used with <code>Write::write_vectored</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IoSliceMut.html" title="rustix::io::IoSliceMut struct">IoSliceMut</a></div><div class="item-right docblock-short"><p>A buffer type used with <code>Read::read_vectored</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IoSliceRaw.html" title="rustix::io::IoSliceRaw struct">IoSliceRaw</a></div><div class="item-right docblock-short"><p>A buffer type used with <code>vmsplice</code>.
It is guaranteed to be ABI compatible with the iovec type on Unix platforms and WSABUF on Windows.
Unlike <code>IoSlice</code> and <code>IoSliceMut</code> it is semantically like a raw pointer,
and therefore can be shared or mutated as needed.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PipeFlags.html" title="rustix::io::PipeFlags struct">PipeFlags</a></div><div class="item-right docblock-short"><p><code>O_*</code> constants for use with <a href="fn.pipe_with.html"><code>pipe_with</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollFd.html" title="rustix::io::PollFd struct">PollFd</a></div><div class="item-right docblock-short"><p><code>struct pollfd</code>—File descriptor and flags for use with <a href="fn.poll.html"><code>poll</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PollFlags.html" title="rustix::io::PollFlags struct">PollFlags</a></div><div class="item-right docblock-short"><p><code>POLL*</code> flags for use with <a href="fn.poll.html"><code>poll</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ReadWriteFlags.html" title="rustix::io::ReadWriteFlags struct">ReadWriteFlags</a></div><div class="item-right docblock-short"><p><code>RWF_*</code> constants for use with <a href="fn.preadv2.html"><code>preadv2</code></a> and <a href="fn.pwritev.html"><code>pwritev2</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SpliceFlags.html" title="rustix::io::SpliceFlags struct">SpliceFlags</a></div><div class="item-right docblock-short"><p><code>SPLICE_F_*</code> constants for use with [<code>splice</code>] and [<code>vmsplice</code>].</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SeekFrom.html" title="rustix::io::SeekFrom enum">SeekFrom</a></div><div class="item-right docblock-short"><p>Enumeration of possible methods to seek within an I/O object.</p>
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PIPE_BUF.html" title="rustix::io::PIPE_BUF constant">PIPE_BUF</a></div><div class="item-right docblock-short"><p><code>PIPE_BUF</code>—The maximum length at which writes to a pipe are atomic.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.close.html" title="rustix::io::close fn">close</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>close(raw_fd)</code>—Closes a <code>RawFd</code> directly.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dup.html" title="rustix::io::dup fn">dup</a></div><div class="item-right docblock-short"><p><code>dup(fd)</code>—Creates a new <code>OwnedFd</code> instance that shares the same
underlying <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> as <code>fd</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dup2.html" title="rustix::io::dup2 fn">dup2</a></div><div class="item-right docblock-short"><p><code>dup2(fd, new)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file descriptor.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dup3.html" title="rustix::io::dup3 fn">dup3</a></div><div class="item-right docblock-short"><p><code>dup3(fd, new, flags)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file
descriptor, with flags.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.eventfd.html" title="rustix::io::eventfd fn">eventfd</a></div><div class="item-right docblock-short"><p><code>eventfd(initval, flags)</code>—Creates a file descriptor for event
notification.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fcntl_dupfd_cloexec.html" title="rustix::io::fcntl_dupfd_cloexec fn">fcntl_dupfd_cloexec</a></div><div class="item-right docblock-short"><p><code>fcntl(fd, F_DUPFD_CLOEXEC)</code>—Creates a new <code>OwnedFd</code> instance, with value
at least <code>min</code>, that has <code>O_CLOEXEC</code> set and that shares the same
underlying [file description] as <code>fd</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fcntl_getfd.html" title="rustix::io::fcntl_getfd fn">fcntl_getfd</a></div><div class="item-right docblock-short"><p><code>fcntl(fd, F_GETFD)</code>—Returns a file descriptor’s flags.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fcntl_setfd.html" title="rustix::io::fcntl_setfd fn">fcntl_setfd</a></div><div class="item-right docblock-short"><p><code>fcntl(fd, F_SETFD, flags)</code>—Sets a file descriptor’s flags.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_blkpbszget.html" title="rustix::io::ioctl_blkpbszget fn">ioctl_blkpbszget</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, BLKPBSZGET)</code>—Returns the physical block size of a block device.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_blksszget.html" title="rustix::io::ioctl_blksszget fn">ioctl_blksszget</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, BLKSSZGET)</code>—Returns the logical block size of a block device.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_fionbio.html" title="rustix::io::ioctl_fionbio fn">ioctl_fionbio</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, FIONBIO, &amp;value)</code>—Enables or disables non-blocking mode.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_fionread.html" title="rustix::io::ioctl_fionread fn">ioctl_fionread</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, FIONREAD)</code>—Returns the number of bytes ready to be read.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_tiocexcl.html" title="rustix::io::ioctl_tiocexcl fn">ioctl_tiocexcl</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, TIOCEXCL)</code>—Enables exclusive mode on a terminal.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.ioctl_tiocnxcl.html" title="rustix::io::ioctl_tiocnxcl fn">ioctl_tiocnxcl</a></div><div class="item-right docblock-short"><p><code>ioctl(fd, TIOCNXCL)</code>—Disables exclusive mode on a terminal.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pipe.html" title="rustix::io::pipe fn">pipe</a></div><div class="item-right docblock-short"><p><code>pipe()</code>—Creates a pipe.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pipe_with.html" title="rustix::io::pipe_with fn">pipe_with</a></div><div class="item-right docblock-short"><p><code>pipe2(flags)</code>—Creates a pipe, with flags.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.poll.html" title="rustix::io::poll fn">poll</a></div><div class="item-right docblock-short"><p><code>poll(self.fds, timeout)</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pread.html" title="rustix::io::pread fn">pread</a></div><div class="item-right docblock-short"><p><code>pread(fd, buf, offset)</code>—Reads from a file at a given position.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.preadv.html" title="rustix::io::preadv fn">preadv</a></div><div class="item-right docblock-short"><p><code>preadv(fd, bufs, offset)</code>—Reads from a file at a given position into
multiple buffers.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.preadv2.html" title="rustix::io::preadv2 fn">preadv2</a></div><div class="item-right docblock-short"><p><code>preadv2(fd, bufs, offset, flags)</code>—Reads data, with several options.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pwrite.html" title="rustix::io::pwrite fn">pwrite</a></div><div class="item-right docblock-short"><p><code>pwrite(fd, bufs)</code>—Writes to a file at a given position.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pwritev.html" title="rustix::io::pwritev fn">pwritev</a></div><div class="item-right docblock-short"><p><code>pwritev(fd, bufs, offset)</code>—Writes to a file at a given position from
multiple buffers.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.pwritev2.html" title="rustix::io::pwritev2 fn">pwritev2</a></div><div class="item-right docblock-short"><p><code>pwritev2(fd, bufs, offset, flags)</code>—Writes data, with several options.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.raw_stderr.html" title="rustix::io::raw_stderr fn">raw_stderr</a></div><div class="item-right docblock-short"><p><code>STDERR_FILENO</code>—Standard error, raw.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.raw_stdin.html" title="rustix::io::raw_stdin fn">raw_stdin</a></div><div class="item-right docblock-short"><p><code>STDIN_FILENO</code>—Standard input, raw.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.raw_stdout.html" title="rustix::io::raw_stdout fn">raw_stdout</a></div><div class="item-right docblock-short"><p><code>STDOUT_FILENO</code>—Standard output, raw.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.read.html" title="rustix::io::read fn">read</a></div><div class="item-right docblock-short"><p><code>read(fd, buf)</code>—Reads from a stream.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.readv.html" title="rustix::io::readv fn">readv</a></div><div class="item-right docblock-short"><p><code>readv(fd, bufs)</code>—Reads from a stream into multiple buffers.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.retry_on_intr.html" title="rustix::io::retry_on_intr fn">retry_on_intr</a></div><div class="item-right docblock-short"><p>Call <code>f</code> until it either succeeds or fails other than <a href="struct.Errno.html#associatedconstant.INTR" title="Errno::INTR"><code>Errno::INTR</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.splice.html" title="rustix::io::splice fn">splice</a></div><div class="item-right docblock-short"><p><code>splice(fd_in, off_in, fd_out, off_out, len, flags)</code>—Transfer data between a file and a pipe.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.stderr.html" title="rustix::io::stderr fn">stderr</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDERR_FILENO</code>—Standard error, borrowed.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.stdin.html" title="rustix::io::stdin fn">stdin</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDIN_FILENO</code>—Standard input, borrowed.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.stdout.html" title="rustix::io::stdout fn">stdout</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDOUT_FILENO</code>—Standard output, borrowed.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_stderr.html" title="rustix::io::take_stderr fn">take_stderr</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDERR_FILENO</code>—Standard error, owned.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_stdin.html" title="rustix::io::take_stdin fn">take_stdin</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDIN_FILENO</code>—Standard input, owned.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_stdout.html" title="rustix::io::take_stdout fn">take_stdout</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>STDOUT_FILENO</code>—Standard output, owned.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.vmsplice.html" title="rustix::io::vmsplice fn">vmsplice</a><a title="unsafe function" href="#"><sup>⚠</sup></a></div><div class="item-right docblock-short"><p><code>vmsplice(fd, bufs, flags)</code>—Transfer data between memory and a pipe.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.write.html" title="rustix::io::write fn">write</a></div><div class="item-right docblock-short"><p><code>write(fd, buf)</code>—Writes to a stream.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.writev.html" title="rustix::io::writev fn">writev</a></div><div class="item-right docblock-short"><p><code>writev(fd, bufs)</code>—Writes to a stream from multiple buffers.</p>
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="rustix::io::Result type">Result</a></div><div class="item-right docblock-short"><p>A specialized <a href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html"><code>Result</code></a> type for <code>rustix</code> APIs.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

11
doc/rustix/io/ioctl/fn.ioctl_blkpbszget.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_blkpbszget.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_blkpbszget.html">../../../rustix/io/fn.ioctl_blkpbszget.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_blkpbszget.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/ioctl/fn.ioctl_blksszget.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_blksszget.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_blksszget.html">../../../rustix/io/fn.ioctl_blksszget.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_blksszget.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/ioctl/fn.ioctl_fionbio.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_fionbio.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_fionbio.html">../../../rustix/io/fn.ioctl_fionbio.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_fionbio.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/ioctl/fn.ioctl_fionread.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_fionread.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_fionread.html">../../../rustix/io/fn.ioctl_fionread.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_fionread.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/ioctl/fn.ioctl_tiocexcl.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_tiocexcl.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_tiocexcl.html">../../../rustix/io/fn.ioctl_tiocexcl.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_tiocexcl.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/ioctl/fn.ioctl_tiocnxcl.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.ioctl_tiocnxcl.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.ioctl_tiocnxcl.html">../../../rustix/io/fn.ioctl_tiocnxcl.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.ioctl_tiocnxcl.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/pipe/constant.PIPE_BUF.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/constant.PIPE_BUF.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/constant.PIPE_BUF.html">../../../rustix/io/constant.PIPE_BUF.html</a>...</p>
<script>location.replace("../../../rustix/io/constant.PIPE_BUF.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/pipe/fn.pipe.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pipe.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pipe.html">../../../rustix/io/fn.pipe.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pipe.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/pipe/fn.pipe_with.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pipe_with.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pipe_with.html">../../../rustix/io/fn.pipe_with.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pipe_with.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/pipe/fn.splice.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.splice.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.splice.html">../../../rustix/io/fn.splice.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.splice.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/pipe/fn.vmsplice.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.vmsplice.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.vmsplice.html">../../../rustix/io/fn.vmsplice.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.vmsplice.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/poll/fn.poll.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.poll.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.poll.html">../../../rustix/io/fn.poll.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.poll.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.pread.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pread.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pread.html">../../../rustix/io/fn.pread.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pread.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.preadv.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.preadv.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.preadv.html">../../../rustix/io/fn.preadv.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.preadv.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.preadv2.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.preadv2.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.preadv2.html">../../../rustix/io/fn.preadv2.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.preadv2.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.pwrite.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pwrite.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pwrite.html">../../../rustix/io/fn.pwrite.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pwrite.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.pwritev.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pwritev.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pwritev.html">../../../rustix/io/fn.pwritev.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pwritev.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.pwritev2.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.pwritev2.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pwritev2.html">../../../rustix/io/fn.pwritev2.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pwritev2.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.read.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.read.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.read.html">../../../rustix/io/fn.read.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.read.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.readv.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.readv.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.readv.html">../../../rustix/io/fn.readv.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.readv.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.write.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.write.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.write.html">../../../rustix/io/fn.write.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.write.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/fn.writev.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.writev.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.writev.html">../../../rustix/io/fn.writev.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.writev.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/struct.IoSlice.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/struct.IoSlice.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/struct.IoSlice.html">../../../rustix/io/struct.IoSlice.html</a>...</p>
<script>location.replace("../../../rustix/io/struct.IoSlice.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/read_write/struct.IoSliceMut.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/struct.IoSliceMut.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/struct.IoSliceMut.html">../../../rustix/io/struct.IoSliceMut.html</a>...</p>
<script>location.replace("../../../rustix/io/struct.IoSliceMut.html" + location.search + location.hash);</script>
</body>
</html>

1
doc/rustix/io/sidebar-items.js Normal file
View File

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"constant":[["PIPE_BUF","`PIPE_BUF`—The maximum length at which writes to a pipe are atomic."]],"enum":[["SeekFrom","Enumeration of possible methods to seek within an I/O object."]],"fn":[["close","`close(raw_fd)`—Closes a `RawFd` directly."],["dup","`dup(fd)`—Creates a new `OwnedFd` instance that shares the same underlying file description as `fd`."],["dup2","`dup2(fd, new)`—Changes the file description of a file descriptor."],["dup3","`dup3(fd, new, flags)`—Changes the file description of a file descriptor, with flags."],["eventfd","`eventfd(initval, flags)`—Creates a file descriptor for event notification."],["fcntl_dupfd_cloexec","`fcntl(fd, F_DUPFD_CLOEXEC)`—Creates a new `OwnedFd` instance, with value at least `min`, that has `O_CLOEXEC` set and that shares the same underlying [file description] as `fd`."],["fcntl_getfd","`fcntl(fd, F_GETFD)`—Returns a file descriptor’s flags."],["fcntl_setfd","`fcntl(fd, F_SETFD, flags)`—Sets a file descriptor’s flags."],["ioctl_blkpbszget","`ioctl(fd, BLKPBSZGET)`—Returns the physical block size of a block device."],["ioctl_blksszget","`ioctl(fd, BLKSSZGET)`—Returns the logical block size of a block device."],["ioctl_fionbio","`ioctl(fd, FIONBIO, &value)`—Enables or disables non-blocking mode."],["ioctl_fionread","`ioctl(fd, FIONREAD)`—Returns the number of bytes ready to be read."],["ioctl_tiocexcl","`ioctl(fd, TIOCEXCL)`—Enables exclusive mode on a terminal."],["ioctl_tiocnxcl","`ioctl(fd, TIOCNXCL)`—Disables exclusive mode on a terminal."],["pipe","`pipe()`—Creates a pipe."],["pipe_with","`pipe2(flags)`—Creates a pipe, with flags."],["poll","`poll(self.fds, timeout)`"],["pread","`pread(fd, buf, offset)`—Reads from a file at a given position."],["preadv","`preadv(fd, bufs, offset)`—Reads from a file at a given position into multiple buffers."],["preadv2","`preadv2(fd, bufs, offset, flags)`—Reads data, with several options."],["pwrite","`pwrite(fd, bufs)`—Writes to a file at a given position."],["pwritev","`pwritev(fd, bufs, offset)`—Writes to a file at a given position from multiple buffers."],["pwritev2","`pwritev2(fd, bufs, offset, flags)`—Writes data, with several options."],["raw_stderr","`STDERR_FILENO`—Standard error, raw."],["raw_stdin","`STDIN_FILENO`—Standard input, raw."],["raw_stdout","`STDOUT_FILENO`—Standard output, raw."],["read","`read(fd, buf)`—Reads from a stream."],["readv","`readv(fd, bufs)`—Reads from a stream into multiple buffers."],["retry_on_intr","Call `f` until it either succeeds or fails other than [`Errno::INTR`]."],["splice","`splice(fd_in, off_in, fd_out, off_out, len, flags)`—Transfer data between a file and a pipe."],["stderr","`STDERR_FILENO`—Standard error, borrowed."],["stdin","`STDIN_FILENO`—Standard input, borrowed."],["stdout","`STDOUT_FILENO`—Standard output, borrowed."],["take_stderr","`STDERR_FILENO`—Standard error, owned."],["take_stdin","`STDIN_FILENO`—Standard input, owned."],["take_stdout","`STDOUT_FILENO`—Standard output, owned."],["vmsplice","`vmsplice(fd, bufs, flags)`—Transfer data between memory and a pipe."],["write","`write(fd, buf)`—Writes to a stream."],["writev","`writev(fd, bufs)`—Writes to a stream from multiple buffers."]],"mod":[["epoll","epoll support."]],"struct":[["DupFlags","`O_*` constants for use with `dup2`."],["Errno","The error type for `rustix` APIs."],["EventfdFlags","`EFD_*` flags for use with `eventfd`."],["FdFlags","`FD_*` constants for use with `fcntl_getfd` and `fcntl_setfd`."],["IoSlice","A buffer type used with `Write::write_vectored`."],["IoSliceMut","A buffer type used with `Read::read_vectored`."],["IoSliceRaw","A buffer type used with `vmsplice`. It is guaranteed to be ABI compatible with the iovec type on Unix platforms and WSABUF on Windows. Unlike `IoSlice` and `IoSliceMut` it is semantically like a raw pointer, and therefore can be shared or mutated as needed."],["PipeFlags","`O_*` constants for use with `pipe_with`."],["PollFd","`struct pollfd`—File descriptor and flags for use with `poll`."],["PollFlags","`POLL*` flags for use with `poll`."],["ReadWriteFlags","`RWF_*` constants for use with `preadv2` and `pwritev2`."],["SpliceFlags","`SPLICE_F_*` constants for use with [`splice`] and [`vmsplice`]."]],"type":[["Result","A specialized `Result` type for `rustix` APIs."]]};

11
doc/rustix/io/stdio/fn.raw_stderr.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.raw_stderr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.raw_stderr.html">../../../rustix/io/fn.raw_stderr.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.raw_stderr.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.raw_stdin.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.raw_stdin.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.raw_stdin.html">../../../rustix/io/fn.raw_stdin.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.raw_stdin.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.raw_stdout.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.raw_stdout.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.raw_stdout.html">../../../rustix/io/fn.raw_stdout.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.raw_stdout.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.stderr.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.stderr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.stderr.html">../../../rustix/io/fn.stderr.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.stderr.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.stdin.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.stdin.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.stdin.html">../../../rustix/io/fn.stdin.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.stdin.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.stdout.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.stdout.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.stdout.html">../../../rustix/io/fn.stdout.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.stdout.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.take_stderr.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.take_stderr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.take_stderr.html">../../../rustix/io/fn.take_stderr.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.take_stderr.html" + location.search + location.hash);</script>
</body>
</html>

11
doc/rustix/io/stdio/fn.take_stdin.html Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../rustix/io/fn.take_stdin.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.take_stdin.html">../../../rustix/io/fn.take_stdin.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.take_stdin.html" + location.search + location.hash);</script>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More