19 lines
5.4 KiB
HTML
19 lines
5.4 KiB
HTML
<!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."><meta name="keywords" content="rust, rustlang, rust-lang, stdout"><title>stdout in rustix::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">☰</button><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rustix/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In rustix::io</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../rustix/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">rustix</a>::<wbr><a href="index.html">io</a>::<wbr><a class="fn" href="#">stdout</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/rustix/io/stdio.rs.html#102-104">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub const unsafe fn stdout() -> <a class="struct" href="../fd/struct.BorrowedFd.html" title="struct rustix::fd::BorrowedFd">BorrowedFd</a><'static></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>STDOUT_FILENO</code>—Standard output, borrowed.</p>
|
||
<h2 id="safety"><a href="#safety">Safety</a></h2>
|
||
<p>This function must be called from code which knows how the process’
|
||
standard output is being used. Often, this will be the <code>main</code> function or
|
||
code that knows its relationship with the <code>main</code> function.</p>
|
||
<p>The stdout file descriptor can be closed, potentially on other threads, in
|
||
which case the file descriptor index value could be dynamically reused for
|
||
other purposes, potentially on different threads.</p>
|
||
<h2 id="other-hazards"><a href="#other-hazards">Other hazards</a></h2>
|
||
<p>Stdout could be redirected to arbitrary output sinks, and unless one
|
||
knows how the process’ standard output is being used, one could
|
||
unexpectedly inject bytes into a stream being written by another part of
|
||
the process.</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>
|
||
</ul>
|
||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustix" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |