Files
phy/rustix/io/fn.dup3.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

15 lines
4.6 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="`dup3(fd, new, flags)`—Changes the file description of a file descriptor, with flags."><title>dup3 in 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 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" 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="#">dup3</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>io</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>::<wbr><a href="index.html">io</a></span><h1>Function <span class="fn">dup3</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/dup.rs.html#123-125">Source</a> </span></div><pre class="rust item-decl"><code>pub fn dup3&lt;Fd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(fd: Fd, new: &amp;mut <a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>, flags: <a class="struct" href="struct.DupFlags.html" title="struct rustix::io::DupFlags">DupFlags</a>) -&gt; <a class="type" href="type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><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.</p>
<p><code>dup3</code> is the same as <a href="fn.dup2.html" title="fn rustix::io::dup2"><code>dup2</code></a> but adds an additional flags operand, and it
fails in the case that <code>fd</code> and <code>new</code> have the same file descriptor value.
This additional difference is the reason this function isnt named
<code>dup2_with</code>.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://man7.org/linux/man-pages/man2/dup3.2.html">Linux</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=dup3&amp;sektion=3">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/dup3.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/dup3.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=dup3&amp;section=3">DragonFly BSD</a></li>
</ul>
</div></details></section></div></main></body></html>