difftastic/rustdoc/rustix/stdio/fn.take_stdin.html

22 lines
5.5 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="`STDIN_FILENO`—Standard input, owned."><title>take_stdin in 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 fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></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><div class="sidebar-elems"><h2><a href="index.html">In rustix::stdio</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>Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">stdio</a>::<wbr><a class="fn" href="#">take_stdin</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#137-139">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe fn take_stdin() -&gt; <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDIN_FILENO</code>—Standard input, owned.</p>
<p>This is similar to <a href="fn.stdin.html" title="fn rustix::stdio::stdin"><code>stdin</code></a>, however it returns an <code>OwnedFd</code> which closes
standard input when it is dropped.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>Safe <code>std</code>-using Rust code is permitted to assume that the stdin file
descriptor is always valid. This function returns an <code>OwnedFd</code> which will
close the stdin file descriptor when dropped.</p>
<h2 id="warning"><a href="#warning">Warning</a></h2>
<p>This has the same hazards as <a href="fn.stdin.html" title="fn rustix::stdio::stdin"><code>stdin</code></a>.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdin.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdin.3.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=stdin&amp;sektion=4">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/stdin.4">NetBSD</a></li>
<li><a href="https://man.openbsd.org/stdin.4">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=stdin&amp;section=4">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/4FS/stdin">illumos</a></li>
<li><a href="https://www.gnu.org/software/libc/manual/html_node/Standard-Streams.html#index-stdin">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>