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

21 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="`STDOUT_FILENO`—Standard output, borrowed."><title>stdout 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="#">stdout</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#174-178">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub const fn stdout() -&gt; <a class="struct" href="../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a>&lt;'static&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDOUT_FILENO</code>—Standard output, borrowed.</p>
<p>In <code>std</code>-using configurations, this is a safe function, because the
standard library already assumes that the stdout file descriptor is always
valid. In <code>no_std</code> configurations, it is <code>unsafe</code>.</p>
<h2 id="warning"><a href="#warning">Warning</a></h2>
<p>This function allows writing directly to stdout without coordinating
with the buffering performed by <a href="https://doc.rust-lang.org/1.76.0/std/io/stdio/struct.Stdout.html" title="struct std::io::stdio::Stdout"><code>std::io::Stdout</code></a>, so it could cause
corrupted output.</p>
<h2 id="references"><a href="#references">References</a></h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/stdout.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man3/stdout.3.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=stdout&amp;sektion=4">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/stdout.4">NetBSD</a></li>
<li><a href="https://man.openbsd.org/stdout.4">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=stdout&amp;section=4">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/4FS/stdout">illumos</a></li>
<li><a href="https://www.gnu.org/software/libc/manual/html_node/Standard-Streams.html#index-stdout">glibc</a></li>
</ul>
</div></details></section></div></main></body></html>