mpvrc/rustix/fs/fn.openat.html

16 lines
No EOL
4.3 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="`openat(dirfd, path, oflags, mode)`—Opens a file."><title>openat in rustix::fs - 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.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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.42</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">openat</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>fs</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">fs</a></span><h1>Function <span class="fn">openat</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/fs/at.rs.html#62-71">Source</a> </span></div><pre class="rust item-decl"><code>pub fn openat&lt;P: <a class="trait" href="../path/trait.Arg.html" title="trait rustix::path::Arg">Arg</a>, Fd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>&gt;(
dirfd: Fd,
path: P,
oflags: <a class="struct" href="struct.OFlags.html" title="struct rustix::fs::OFlags">OFlags</a>,
create_mode: <a class="struct" href="struct.Mode.html" title="struct rustix::fs::Mode">Mode</a>,
) -&gt; <a class="type" href="../io/type.Result.html" title="type rustix::io::Result">Result</a>&lt;<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>openat(dirfd, path, oflags, mode)</code>—Opens a file.</p>
<p>POSIX guarantees that <code>openat</code> will use the lowest unused file descriptor,
however it is not safe in general to rely on this, as file descriptors may
be unexpectedly allocated on other threads or in libraries.</p>
<p>The <code>Mode</code> argument is only significant when creating a file.</p>
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
<ul>
<li><a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/openat.html">POSIX</a></li>
<li><a href="https://man7.org/linux/man-pages/man2/openat.2.html">Linux</a></li>
</ul>
</div></details></section></div></main></body></html>