NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-18 00:38:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
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>

11
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
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
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>

11
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
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
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
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
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>

25
rustix/io/fn.close.html Normal file
View file

@ -0,0 +1,25 @@
<!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."><title>close in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">close</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li><li><a href="#safety" title="Safety">Safety</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">close</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/close.rs.html#53-55">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn close(raw_fd: <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a>)</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#close-and-shutdownget-outta-my-face">Beej’s Guide to Network Programming</a></li>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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">Winsock</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=close&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/close.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/close.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=close&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/close">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Opening-and-Closing-Files.html#index-close">glibc</a></li>
</ul>
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</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></body></html>

20
rustix/io/fn.dup.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="`dup(fd)`—Creates a new `OwnedFd` instance that shares the same underlying file description as `fd`."><title>dup in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">dup</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">dup</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/dup.rs.html#44-46">Source</a> </span></div><pre class="rust item-decl"><code>pub fn dup&lt;Fd: <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><details class="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/9799919799/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" title="fn rustix::io::fcntl_dupfd_cloexec"><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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=dup&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/dup.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/dup.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=dup&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/dup">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Duplicating-Descriptors.html">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

23
rustix/io/fn.dup2.html Normal file
View file

@ -0,0 +1,23 @@
<!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."><title>dup2 in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">dup2</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">dup2</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/dup.rs.html#89-91">Source</a> </span></div><pre class="rust item-decl"><code>pub fn dup2&lt;Fd: <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.84.1/std/primitive.unit.html">()</a>&gt;</code></pre><details class="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/9799919799/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="fn rustix::io::dup3"><code>dup3</code></a> with <a href="struct.DupFlags.html#associatedconstant.CLOEXEC" title="associated constant rustix::io::DupFlags::CLOEXEC"><code>DupFlags::CLOEXEC</code></a> on platforms which
support it, or <a href="fn.fcntl_dupfd_cloexec.html" title="fn rustix::io::fcntl_dupfd_cloexec"><code>fcntl_dupfd_cloexec</code></a>.</p>
<p>For <code>dup2</code> to stdin, stdout, and stderr, see <a href="https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stdin.html"><code>stdio::dup2_stdin</code></a>,
<a href="https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stdout.html"><code>stdio::dup2_stdout</code></a>, and <a href="https://docs.rs/rustix/*/rustix/stdio/fn.dup2_stderr.html"><code>stdio::dup2_stderr</code></a>.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=dup2&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/dup2.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/dup2.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=dup2&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/dup">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Duplicating-Descriptors.html">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

15
rustix/io/fn.dup3.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="`dup3(fd, new, flags)`—Changes the file description of a file descriptor, with flags."><title>dup3 in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">dup3</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">dup3</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/dup.rs.html#123-125">Source</a> </span></div><pre class="rust item-decl"><code>pub fn dup3&lt;Fd: <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.84.1/std/primitive.unit.html">()</a>&gt;</code></pre><details class="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/9799919799/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="fn rustix::io::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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/dup3.2.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=dup3&amp;sektion=3">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/dup3.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/dup3.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=dup3&amp;section=3">DragonFly BSD</a></li>
</ul>
</div></details></section></div></main></body></html>

20
rustix/io/fn.fcntl_dupfd_cloexec.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="`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`."><title>fcntl_dupfd_cloexec in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">fcntl_<wbr>dupfd_<wbr>cloexec</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">fcntl_dupfd_cloexec</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/fcntl.rs.html#105-107">Source</a> </span></div><pre class="rust item-decl"><code>pub fn fcntl_dupfd_cloexec&lt;Fd: <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><details class="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 <a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_258">file description</a> 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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/fcntl.2.html">Apple</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=fcntl&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/fcntl.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/fcntl.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=fcntl&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/fcntl">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Control-Operations.html#index-fcntl-function">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

14
rustix/io/fn.fcntl_getfd.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="`fcntl(fd, F_GETFD)`—Returns a file descriptor’s flags."><title>fcntl_getfd in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">fcntl_<wbr>getfd</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">fcntl_getfd</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/fcntl.rs.html#40-42">Source</a> </span></div><pre class="rust item-decl"><code>pub fn fcntl_getfd&lt;Fd: <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><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/fcntl.2.html">Apple</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=fcntl&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/fcntl.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/fcntl.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=fcntl&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/fcntl">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Control-Operations.html#index-fcntl-function">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

14
rustix/io/fn.fcntl_setfd.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="`fcntl(fd, F_SETFD, flags)`—Sets a file descriptor’s flags."><title>fcntl_setfd in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">fcntl_<wbr>setfd</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">fcntl_setfd</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/fcntl.rs.html#68-70">Source</a> </span></div><pre class="rust item-decl"><code>pub fn fcntl_setfd&lt;Fd: <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.84.1/std/primitive.unit.html">()</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/fcntl.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/fcntl.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/fcntl.2.html">Apple</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=fcntl&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/fcntl.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/fcntl.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=fcntl&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/fcntl">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Control-Operations.html#index-fcntl-function">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

8
rustix/io/fn.ioctl_fionbio.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="`ioctl(fd, FIONBIO, &#38;value)`—Enables or disables non-blocking mode."><title>ioctl_fionbio in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ioctl_<wbr>fionbio</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">ioctl_fionbio</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/ioctl.rs.html#43-49">Source</a> </span></div><pre class="rust item-decl"><code>pub fn ioctl_fionbio&lt;Fd: <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.84.1/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.84.1/std/primitive.unit.html">()</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/winsock/winsock-ioctls#unix-ioctl-codes">Winsock</a></li>
<li><a href="https://man.netbsd.org/ioctl.2#GENERIC%20IOCTLS">NetBSD</a></li>
<li><a href="https://man.openbsd.org/ioctl.2#GENERIC_IOCTLS">OpenBSD</a></li>
</ul>
</div></details></section></div></main></body></html>

12
rustix/io/fn.ioctl_fionread.html Normal file
View file

@ -0,0 +1,12 @@
<!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."><title>ioctl_fionread in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ioctl_<wbr>fionread</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">ioctl_fionread</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/ioctl.rs.html#71-77">Source</a> </span></div><pre class="rust item-decl"><code>pub fn ioctl_fionread&lt;Fd: <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.84.1/std/primitive.u64.html">u64</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</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">Winsock</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=ioctl&amp;sektion=2#GENERIC%09IOCTLS">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/ioctl.2#GENERIC%20IOCTLS">NetBSD</a></li>
<li><a href="https://man.openbsd.org/ioctl.2#GENERIC_IOCTLS">OpenBSD</a></li>
</ul>
</div></details></section></div></main></body></html>

16
rustix/io/fn.pread.html Normal file
View file

@ -0,0 +1,16 @@
<!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."><title>pread in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pread</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">pread</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#119-121">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pread&lt;Fd: <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.84.1/std/primitive.u8.html">u8</a>], offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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>
<p>This takes a <code>&amp;mut [u8]</code> which Rust requires to contain initialized memory.
To use an uninitialized buffer, use <a href="fn.pread_uninit.html" title="fn rustix::io::pread_uninit"><code>pread_uninit</code></a>.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=pread&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/pread.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/pread.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=pread&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/pread">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/I_002fO-Primitives.html#index-pread64">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

9
rustix/io/fn.pread_uninit.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="`pread(fd, buf, offset)`—Reads from a file at a given position."><title>pread_uninit in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">pread_uninit</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#129-138">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pread_uninit&lt;Fd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(
fd: Fd,
buf: &amp;mut [<a class="union" href="https://doc.rust-lang.org/1.84.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;],
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>,
) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;(&amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>], &amp;mut [<a class="union" href="https://doc.rust-lang.org/1.84.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;])&gt;</code></pre><details class="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>
<p>This is equivalent to <a href="fn.pread.html" title="fn rustix::io::pread"><code>pread</code></a>, except that it can read into uninitialized
memory. It returns the slice that was initialized by this function and the
slice that remains uninitialized.</p>
</div></details></section></div></main></body></html>

17
rustix/io/fn.preadv.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="`preadv(fd, bufs, offset)`—Reads from a file at a given position into multiple buffers."><title>preadv in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">preadv</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">preadv</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#256-258">Source</a> </span></div><pre class="rust item-decl"><code>pub fn preadv&lt;Fd: <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;],
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/preadv.2.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=preadv&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/preadv.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/preadv.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=preadv&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/preadv">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Scatter_002dGather.html#index-preadv64">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

13
rustix/io/fn.preadv2.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="`preadv2(fd, bufs, offset, flags)`—Reads data, with several options."><title>preadv2 in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">preadv2</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">preadv2</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#309-316">Source</a> </span></div><pre class="rust item-decl"><code>pub fn preadv2&lt;Fd: <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;],
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>,
flags: <a class="struct" href="struct.ReadWriteFlags.html" title="struct rustix::io::ReadWriteFlags">ReadWriteFlags</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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/preadv2.2.html">Linux</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Scatter_002dGather.html#index-preadv64v2">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

17
rustix/io/fn.pwrite.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="`pwrite(fd, bufs)`—Writes to a file at a given position."><title>pwrite in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pwrite</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">pwrite</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#167-169">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pwrite&lt;Fd: <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.84.1/std/primitive.u8.html">u8</a>], offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=pwrite&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/pwrite.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/pwrite.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=pwrite&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/pwrite">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/I_002fO-Primitives.html#index-pwrite64">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

20
rustix/io/fn.pwritev.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="`pwritev(fd, bufs, offset)`—Writes to a file at a given position from multiple buffers."><title>pwritev in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pwritev</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">pwritev</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#293-295">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pwritev&lt;Fd: <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;],
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/pwritev.2.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=pwritev&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/pwritev.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/pwritev.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=pwritev&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/pwritev">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/I_002fO-Primitives.html#index-pwrite64">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

13
rustix/io/fn.pwritev2.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="`pwritev2(fd, bufs, offset, flags)`—Writes data, with several options."><title>pwritev2 in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pwritev2</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">pwritev2</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#330-337">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pwritev2&lt;Fd: <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;],
offset: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>,
flags: <a class="struct" href="struct.ReadWriteFlags.html" title="struct rustix::io::ReadWriteFlags">ReadWriteFlags</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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/pwritev2.2.html">Linux</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Scatter_002dGather.html#index-pwritev64v2">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

16
rustix/io/fn.read.html Normal file
View file

@ -0,0 +1,16 @@
<!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."><title>read in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">read</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">read</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#43-45">Source</a> </span></div><pre class="rust item-decl"><code>pub fn read&lt;Fd: <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.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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>
<p>This takes a <code>&amp;mut [u8]</code> which Rust requires to contain initialized memory.
To use an uninitialized buffer, use <a href="fn.read_uninit.html" title="fn rustix::io::read_uninit"><code>read_uninit</code></a>.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=read&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/read.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/read.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=read&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/read">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/I_002fO-Primitives.html#index-reading-from-a-file-descriptor">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

8
rustix/io/fn.read_uninit.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."><title>read_uninit in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">read_uninit</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#53-64">Source</a> </span></div><pre class="rust item-decl"><code>pub fn read_uninit&lt;Fd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(
fd: Fd,
buf: &amp;mut [<a class="union" href="https://doc.rust-lang.org/1.84.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;],
) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;(&amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>], &amp;mut [<a class="union" href="https://doc.rust-lang.org/1.84.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;])&gt;</code></pre><details class="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>
<p>This is equivalent to <a href="fn.read.html" title="fn rustix::io::read"><code>read</code></a>, except that it can read into uninitialized
memory. It returns the slice that was initialized by this function and the
slice that remains uninitialized.</p>
</div></details></section></div></main></body></html>

14
rustix/io/fn.readv.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="`readv(fd, bufs)`—Reads from a stream into multiple buffers."><title>readv in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">readv</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">readv</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#195-197">Source</a> </span></div><pre class="rust item-decl"><code>pub fn readv&lt;Fd: <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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=readv&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/readv.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/readv.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=readv&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/readv">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Scatter_002dGather.html#index-readv">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

2
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`."><title>retry_on_intr in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">retry_on_intr</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/errno.rs.html#65-72">Source</a> </span></div><pre class="rust item-decl"><code>pub fn retry_on_intr&lt;T, F: <a class="trait" href="https://doc.rust-lang.org/1.84.1/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><details class="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="associated constant rustix::io::Errno::INTR"><code>Errno::INTR</code></a>.</p>
</div></details></section></div></main></body></html>

14
rustix/io/fn.write.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="`write(fd, buf)`—Writes to a stream."><title>write in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">write</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">write</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#89-91">Source</a> </span></div><pre class="rust item-decl"><code>pub fn write&lt;Fd: <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.84.1/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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=write&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/write.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/write.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=write&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/write">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/I_002fO-Primitives.html#index-writing-to-a-file-descriptor">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

14
rustix/io/fn.writev.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="`writev(fd, bufs)`—Writes to a stream from multiple buffers."><title>writev in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">writev</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">writev</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/read_write.rs.html#223-225">Source</a> </span></div><pre class="rust item-decl"><code>pub fn writev&lt;Fd: <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.84.1/std/primitive.usize.html">usize</a>&gt;</code></pre><details class="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 class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/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>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=writev&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/writev.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/writev.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=writev&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/writev">illumos</a></li>
<li><a href="https://sourceware.org/glibc/manual/latest/html_node/Scatter_002dGather.html#index-writev">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>

9
rustix/io/index.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="I/O operations."><title>rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module io</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rustix</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a></span><h1>Module <span>io</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/mod.rs.html#1-32">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>I/O operations.</p>
<p>If you’re looking for <a href="https://docs.rs/rustix/*/rustix/fs/enum.SeekFrom.html"><code>SeekFrom</code></a>, that’s in the <a href="https://docs.rs/rustix/*/rustix/fs/index.html"><code>fs</code></a> module.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.DupFlags.html" title="struct rustix::io::DupFlags">DupFlags</a></div><div class="desc docblock-short"><code>O_*</code> constants for use with <a href="fn.dup2.html" title="fn rustix::io::dup2"><code>dup2</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Errno.html" title="struct rustix::io::Errno">Errno</a></div><div class="desc docblock-short"><code>errno</code>—An error code.</div></li><li><div class="item-name"><a class="struct" href="struct.FdFlags.html" title="struct rustix::io::FdFlags">FdFlags</a></div><div class="desc docblock-short"><code>FD_*</code> constants for use with <a href="fn.fcntl_getfd.html" title="fn rustix::io::fcntl_getfd"><code>fcntl_getfd</code></a> and <a href="fn.fcntl_setfd.html" title="fn rustix::io::fcntl_setfd"><code>fcntl_setfd</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.IoSlice.html" title="struct rustix::io::IoSlice">IoSlice</a></div><div class="desc docblock-short">A buffer type used with <code>Write::write_vectored</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IoSliceMut.html" title="struct rustix::io::IoSliceMut">IoSlice<wbr>Mut</a></div><div class="desc docblock-short">A buffer type used with <code>Read::read_vectored</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ReadWriteFlags.html" title="struct rustix::io::ReadWriteFlags">Read<wbr>Write<wbr>Flags</a></div><div class="desc docblock-short"><code>RWF_*</code> constants for use with <a href="fn.preadv2.html" title="fn rustix::io::preadv2"><code>preadv2</code></a> and <a href="fn.pwritev.html" title="fn rustix::io::pwritev"><code>pwritev2</code></a>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.close.html" title="fn rustix::io::close">close</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short"><code>close(raw_fd)</code>—Closes a <code>RawFd</code> directly.</div></li><li><div class="item-name"><a class="fn" href="fn.dup.html" title="fn rustix::io::dup">dup</a></div><div class="desc docblock-short"><code>dup(fd)</code>—Creates a new <code>OwnedFd</code> instance that shares the same
underlying <a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_258">file description</a> as <code>fd</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.dup2.html" title="fn rustix::io::dup2">dup2</a></div><div class="desc docblock-short"><code>dup2(fd, new)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.dup3.html" title="fn rustix::io::dup3">dup3</a></div><div class="desc docblock-short"><code>dup3(fd, new, flags)</code>—Changes the <a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_258">file description</a> of a file
descriptor, with flags.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_dupfd_cloexec.html" title="fn rustix::io::fcntl_dupfd_cloexec">fcntl_<wbr>dupfd_<wbr>cloexec</a></div><div class="desc docblock-short"><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 <a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_258">file description</a> as <code>fd</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_getfd.html" title="fn rustix::io::fcntl_getfd">fcntl_<wbr>getfd</a></div><div class="desc docblock-short"><code>fcntl(fd, F_GETFD)</code>—Returns a file descriptor’s flags.</div></li><li><div class="item-name"><a class="fn" href="fn.fcntl_setfd.html" title="fn rustix::io::fcntl_setfd">fcntl_<wbr>setfd</a></div><div class="desc docblock-short"><code>fcntl(fd, F_SETFD, flags)</code>—Sets a file descriptor’s flags.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_fionbio.html" title="fn rustix::io::ioctl_fionbio">ioctl_<wbr>fionbio</a></div><div class="desc docblock-short"><code>ioctl(fd, FIONBIO, &amp;value)</code>—Enables or disables non-blocking mode.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_fionread.html" title="fn rustix::io::ioctl_fionread">ioctl_<wbr>fionread</a></div><div class="desc docblock-short"><code>ioctl(fd, FIONREAD)</code>—Returns the number of bytes ready to be read.</div></li><li><div class="item-name"><a class="fn" href="fn.pread.html" title="fn rustix::io::pread">pread</a></div><div class="desc docblock-short"><code>pread(fd, buf, offset)</code>—Reads from a file at a given position.</div></li><li><div class="item-name"><a class="fn" href="fn.pread_uninit.html" title="fn rustix::io::pread_uninit">pread_<wbr>uninit</a></div><div class="desc docblock-short"><code>pread(fd, buf, offset)</code>—Reads from a file at a given position.</div></li><li><div class="item-name"><a class="fn" href="fn.preadv.html" title="fn rustix::io::preadv">preadv</a></div><div class="desc docblock-short"><code>preadv(fd, bufs, offset)</code>—Reads from a file at a given position into
multiple buffers.</div></li><li><div class="item-name"><a class="fn" href="fn.preadv2.html" title="fn rustix::io::preadv2">preadv2</a></div><div class="desc docblock-short"><code>preadv2(fd, bufs, offset, flags)</code>—Reads data, with several options.</div></li><li><div class="item-name"><a class="fn" href="fn.pwrite.html" title="fn rustix::io::pwrite">pwrite</a></div><div class="desc docblock-short"><code>pwrite(fd, bufs)</code>—Writes to a file at a given position.</div></li><li><div class="item-name"><a class="fn" href="fn.pwritev.html" title="fn rustix::io::pwritev">pwritev</a></div><div class="desc docblock-short"><code>pwritev(fd, bufs, offset)</code>—Writes to a file at a given position from
multiple buffers.</div></li><li><div class="item-name"><a class="fn" href="fn.pwritev2.html" title="fn rustix::io::pwritev2">pwritev2</a></div><div class="desc docblock-short"><code>pwritev2(fd, bufs, offset, flags)</code>—Writes data, with several options.</div></li><li><div class="item-name"><a class="fn" href="fn.read.html" title="fn rustix::io::read">read</a></div><div class="desc docblock-short"><code>read(fd, buf)</code>—Reads from a stream.</div></li><li><div class="item-name"><a class="fn" href="fn.read_uninit.html" title="fn rustix::io::read_uninit">read_<wbr>uninit</a></div><div class="desc docblock-short"><code>read(fd, buf)</code>—Reads from a stream.</div></li><li><div class="item-name"><a class="fn" href="fn.readv.html" title="fn rustix::io::readv">readv</a></div><div class="desc docblock-short"><code>readv(fd, bufs)</code>—Reads from a stream into multiple buffers.</div></li><li><div class="item-name"><a class="fn" href="fn.retry_on_intr.html" title="fn rustix::io::retry_on_intr">retry_<wbr>on_<wbr>intr</a></div><div class="desc docblock-short">Call <code>f</code> until it either succeeds or fails other than <a href="struct.Errno.html#associatedconstant.INTR" title="associated constant rustix::io::Errno::INTR"><code>Errno::INTR</code></a>.</div></li><li><div class="item-name"><a class="fn" href="fn.write.html" title="fn rustix::io::write">write</a></div><div class="desc docblock-short"><code>write(fd, buf)</code>—Writes to a stream.</div></li><li><div class="item-name"><a class="fn" href="fn.writev.html" title="fn rustix::io::writev">writev</a></div><div class="desc docblock-short"><code>writev(fd, bufs)</code>—Writes to a stream from multiple buffers.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a></div><div class="desc docblock-short">A specialized <a href="type.Result.html" title="type rustix::io::Result"><code>Result</code></a> type for <code>rustix</code> APIs.</div></li></ul></section></div></main></body></html>

11
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
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
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
rustix/io/read_write/fn.pread_uninit.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_uninit.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.pread_uninit.html">../../../rustix/io/fn.pread_uninit.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.pread_uninit.html" + location.search + location.hash);</script>
</body>
</html>

11
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
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
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
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
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
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
rustix/io/read_write/fn.read_uninit.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_uninit.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../rustix/io/fn.read_uninit.html">../../../rustix/io/fn.read_uninit.html</a>...</p>
<script>location.replace("../../../rustix/io/fn.read_uninit.html" + location.search + location.hash);</script>
</body>
</html>

11
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
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
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
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
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
rustix/io/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["close","dup","dup2","dup3","fcntl_dupfd_cloexec","fcntl_getfd","fcntl_setfd","ioctl_fionbio","ioctl_fionread","pread","pread_uninit","preadv","preadv2","pwrite","pwritev","pwritev2","read","read_uninit","readv","retry_on_intr","write","writev"],"struct":["DupFlags","Errno","FdFlags","IoSlice","IoSliceMut","ReadWriteFlags"],"type":["Result"]};

73
rustix/io/struct.DupFlags.html Normal file
View file

File diff suppressed because one or more lines are too long

174
rustix/io/struct.Errno.html Normal file
View file

File diff suppressed because one or more lines are too long

73
rustix/io/struct.FdFlags.html Normal file
View file

File diff suppressed because one or more lines are too long

1217
rustix/io/struct.IoSlice.html Normal file
View file

File diff suppressed because one or more lines are too long

2548
rustix/io/struct.IoSliceMut.html Normal file
View file

File diff suppressed because one or more lines are too long

77
rustix/io/struct.ReadWriteFlags.html Normal file
View file

File diff suppressed because one or more lines are too long

7
rustix/io/type.Result.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="A specialized `Result` type for `rustix` APIs."><title>Result in rustix::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.Err" title="Err">Err</a></li><li><a href="#variant.Ok" title="Ok">Ok</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a></span><h1>Type Alias <span class="type">Result</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/io/errno.rs.html#13">Source</a> </span></div><pre class="rust item-decl"><code>pub type Result&lt;T&gt; = <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="struct.Errno.html" title="struct rustix::io::Errno">Errno</a>&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A specialized <a href="type.Result.html" title="type rustix::io::Result"><code>Result</code></a> type for <code>rustix</code> APIs.</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>enum Result&lt;T&gt; {
Ok(T),
Err(<a class="struct" href="struct.Errno.html" title="struct rustix::io::Errno">Errno</a>),
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Ok" class="variant"><a href="#variant.Ok" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Ok(T)</h3></section><div class="docblock"><p>Contains the success value</p>
</div><section id="variant.Err" class="variant"><a href="#variant.Err" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Err(<a class="struct" href="struct.Errno.html" title="struct rustix::io::Errno">Errno</a>)</h3></section><div class="docblock"><p>Contains the error value</p>
</div></div><script src="../../type.impl/core/result/enum.Result.js" data-self-path="rustix::io::errno::Result" async></script></section></div></main></body></html>