orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
doc
phy/rustix/io/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

10 lines
12 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" 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.37</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.is_read_write.html" title="fn rustix::io::is_read_write">is_<wbr>read_<wbr>write</a></div><div class="desc docblock-short">Returns a pair of booleans indicating whether the file descriptor is
readable and/or writable, respectively.</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>
Reference in New Issue View Git Blame Copy Permalink