difftastic/rustdoc/rustix/stdio/index.html

8 lines
7.1 KiB
HTML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="Functions returning the stdio file descriptors."><title>rustix::stdio - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.34</span></h2></div><h2 class="location"><a href="#">Module stdio</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate rustix</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../rustix/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">rustix</a>::<wbr><a class="mod" href="#">stdio</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/rustix/stdio.rs.html#1-511">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Functions returning the stdio file descriptors.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>These access the file descriptors by absolute index value, and nothing
prevents them from being closed and reused. They should only be used in
<code>main</code> or other situations where one is in control of the process
stdio streams.</p>
</div></details><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.dup2_stderr.html" title="fn rustix::stdio::dup2_stderr">dup2_stderr</a></div><div class="desc docblock-short">Utility function to safely <code>dup2</code> over stderr (fd 2).</div></li><li><div class="item-name"><a class="fn" href="fn.dup2_stdin.html" title="fn rustix::stdio::dup2_stdin">dup2_stdin</a></div><div class="desc docblock-short">Utility function to safely <code>dup2</code> over stdin (fd 0).</div></li><li><div class="item-name"><a class="fn" href="fn.dup2_stdout.html" title="fn rustix::stdio::dup2_stdout">dup2_stdout</a></div><div class="desc docblock-short">Utility function to safely <code>dup2</code> over stdout (fd 1).</div></li><li><div class="item-name"><a class="fn" href="fn.raw_stderr.html" title="fn rustix::stdio::raw_stderr">raw_stderr</a></div><div class="desc docblock-short"><code>STDERR_FILENO</code>—Standard error, raw.</div></li><li><div class="item-name"><a class="fn" href="fn.raw_stdin.html" title="fn rustix::stdio::raw_stdin">raw_stdin</a></div><div class="desc docblock-short"><code>STDIN_FILENO</code>—Standard input, raw.</div></li><li><div class="item-name"><a class="fn" href="fn.raw_stdout.html" title="fn rustix::stdio::raw_stdout">raw_stdout</a></div><div class="desc docblock-short"><code>STDOUT_FILENO</code>—Standard output, raw.</div></li><li><div class="item-name"><a class="fn" href="fn.stderr.html" title="fn rustix::stdio::stderr">stderr</a></div><div class="desc docblock-short"><code>STDERR_FILENO</code>—Standard error, borrowed.</div></li><li><div class="item-name"><a class="fn" href="fn.stdin.html" title="fn rustix::stdio::stdin">stdin</a></div><div class="desc docblock-short"><code>STDIN_FILENO</code>—Standard input, borrowed.</div></li><li><div class="item-name"><a class="fn" href="fn.stdout.html" title="fn rustix::stdio::stdout">stdout</a></div><div class="desc docblock-short"><code>STDOUT_FILENO</code>—Standard output, borrowed.</div></li><li><div class="item-name"><a class="fn" href="fn.take_stderr.html" title="fn rustix::stdio::take_stderr">take_stderr</a><sup title="unsafe function"></sup></div><div class="desc docblock-short"><code>STDERR_FILENO</code>—Standard error, owned.</div></li><li><div class="item-name"><a class="fn" href="fn.take_stdin.html" title="fn rustix::stdio::take_stdin">take_stdin</a><sup title="unsafe function"></sup></div><div class="desc docblock-short"><code>STDIN_FILENO</code>—Standard input, owned.</div></li><li><div class="item-name"><a class="fn" href="fn.take_stdout.html" title="fn rustix::stdio::take_stdout">take_stdout</a><sup title="unsafe function"></sup></div><div class="desc docblock-short"><code>STDOUT_FILENO</code>—Standard output, owned.</div></li></ul></section></div></main></body></html>