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

25 lines
5.1 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="`close(raw_fd)`—Closes a `RawFd` directly."><title>close 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="#">close</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li><li><a href="#safety" title="Safety">Safety</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">close</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/close.rs.html#53-55">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn close(raw_fd: <a class="type" href="../fd/type.RawFd.html" title="type rustix::fd::RawFd">RawFd</a>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>close(raw_fd)</code>—Closes a <code>RawFd</code> directly.</p>
<p>Most users wont need to use this, as <code>OwnedFd</code> automatically closes its
file descriptor on <code>Drop</code>.</p>
<p>This function does not return a <code>Result</code>, as it is the <a href="https://lwn.net/Articles/576518/">responsibility</a> of
filesystem designers to not return errors from <code>close</code>. Users who chose to
use NFS or similar filesystems should take care to monitor for problems
externally.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#close-and-shutdownget-outta-my-face">Beejs Guide to Network Programming</a></li>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/close.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/close.2.html">Linux</a></li>
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/close.2.html#//apple_ref/doc/man/2/close">Apple</a></li>
<li><a href="https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-closesocket">Winsock</a></li>
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=close&amp;sektion=2">FreeBSD</a></li>
<li><a href="https://man.netbsd.org/close.2">NetBSD</a></li>
<li><a href="https://man.openbsd.org/close.2">OpenBSD</a></li>
<li><a href="https://man.dragonflybsd.org/?command=close&amp;section=2">DragonFly BSD</a></li>
<li><a href="https://illumos.org/man/2/close">illumos</a></li>
<li><a href="https://www.gnu.org/software/libc/manual/html_node/Opening-and-Closing-Files.html#index-close">glibc</a></li>
</ul>
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
<p>This function takes a <code>RawFd</code>, which must be valid before the call, and is
not valid after the call.</p>
</div></details></section></div></main></body></html>