28 lines
16 KiB
HTML
28 lines
16 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="A trait to express the ability to construct an object from a raw file descriptor."><meta name="keywords" content="rust, rustlang, rust-lang, FromRawFd"><title>FromRawFd in rustix::fd - 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 trait"><!--[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><h2 class="location"><a href="#">FromRawFd</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.from_raw_fd">from_raw_fd</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In rustix::fd</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">Trait <a href="../index.html">rustix</a>::<wbr><a href="index.html">fd</a>::<wbr><a class="trait" href="#">FromRawFd</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"><span class="since" title="Stable since Rust version 1.1.0">1.1.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/raw.rs.html#64">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 trait"><code>pub trait FromRawFd {
|
||
unsafe fn <a href="#tymethod.from_raw_fd" class="fnname">from_raw_fd</a>(fd: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a>) -> Self;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait to express the ability to construct an object from a raw file
|
||
descriptor.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.from_raw_fd" class="method has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/raw.rs.html#101">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.from_raw_fd" class="fnname">from_raw_fd</a>(fd: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a>) -> Self</h4></div></summary><div class="docblock"><p>Constructs a new instance of <code>Self</code> from the given raw file
|
||
descriptor.</p>
|
||
<p>This function is typically used to <strong>consume ownership</strong> of the
|
||
specified file descriptor. When used in this way, the returned object
|
||
will take responsibility for closing it when the object goes out of
|
||
scope.</p>
|
||
<p>However, consuming ownership is not strictly required. Use a
|
||
<a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" title="From<OwnedFd>::from"><code>From<OwnedFd>::from</code></a> implementation for an API which strictly
|
||
consumes ownership.</p>
|
||
<h5 id="safety"><a href="#safety">Safety</a></h5>
|
||
<p>The <code>fd</code> passed in must be a valid and open file descriptor.</p>
|
||
<h5 id="example"><a href="#example">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::fs::File</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span>
|
||
<span class="kw">use</span> <span class="ident">std::os::unix::io</span>::{<span class="ident">FromRawFd</span>, <span class="ident">IntoRawFd</span>, <span class="ident">RawFd</span>};
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"wasi"</span>)]</span>
|
||
<span class="kw">use</span> <span class="ident">std::os::wasi::io</span>::{<span class="ident">FromRawFd</span>, <span class="ident">IntoRawFd</span>, <span class="ident">RawFd</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">File::open</span>(<span class="string">"foo.txt"</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">raw_fd</span>: <span class="ident">RawFd</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">into_raw_fd</span>();
|
||
<span class="comment">// SAFETY: no other functions should call `from_raw_fd`, so there</span>
|
||
<span class="comment">// is only one owner for the file descriptor.</span>
|
||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">File::from_raw_fd</span>(<span class="ident">raw_fd</span>) };</code></pre></div>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-FromRawFd-for-i32" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.48.0">1.48.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/raw.rs.html#153">source</a></span><a href="#impl-FromRawFd-for-i32" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a></h3></section><section id="impl-FromRawFd-for-File" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/raw.rs.html#168">source</a></span><a href="#impl-FromRawFd-for-File" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/fs/struct.File.html" title="struct std::fs::File">File</a></h3></section><section id="impl-FromRawFd-for-TcpListener" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/net.rs.html#33">source</a></span><a href="#impl-FromRawFd-for-TcpListener" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a></h3></section><section id="impl-FromRawFd-for-TcpStream" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/net.rs.html#33">source</a></span><a href="#impl-FromRawFd-for-TcpStream" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/net/tcp/struct.TcpStream.html" title="struct std::net::tcp::TcpStream">TcpStream</a></h3></section><section id="impl-FromRawFd-for-UdpSocket" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/net.rs.html#33">source</a></span><a href="#impl-FromRawFd-for-UdpSocket" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a></h3></section><section id="impl-FromRawFd-for-PidFd" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/linux/process.rs.html#78">source</a></span><a href="#impl-FromRawFd-for-PidFd" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/os/linux/process/struct.PidFd.html" title="struct std::os::linux::process::PidFd">PidFd</a></h3></section><section id="impl-FromRawFd-for-UnixDatagram" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/datagram.rs.html#950">source</a></span><a href="#impl-FromRawFd-for-UnixDatagram" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/os/unix/net/datagram/struct.UnixDatagram.html" title="struct std::os::unix::net::datagram::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-FromRawFd-for-UnixListener" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/listener.rs.html#288">source</a></span><a href="#impl-FromRawFd-for-UnixListener" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/os/unix/net/listener/struct.UnixListener.html" title="struct std::os::unix::net::listener::UnixListener">UnixListener</a></h3></section><section id="impl-FromRawFd-for-UnixStream" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/stream.rs.html#674">source</a></span><a href="#impl-FromRawFd-for-UnixStream" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/os/unix/net/stream/struct.UnixStream.html" title="struct std::os::unix::net::stream::UnixStream">UnixStream</a></h3></section><section id="impl-FromRawFd-for-Stdio" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.2.0">1.2.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/process.rs.html#346">source</a></span><a href="#impl-FromRawFd-for-Stdio" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/process/struct.Stdio.html" title="struct std::process::Stdio">Stdio</a></h3></section><section id="impl-FromRawFd-for-OwnedFd" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.63.0">1.63.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#150">source</a></span><a href="#impl-FromRawFd-for-OwnedFd" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></h3></section><section id="impl-FromRawFd-for-Epoll%3COwning%3C%27context%2C%20T%3E%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/rustix/backend/linux_raw/io/epoll.rs.html#254-261">source</a></span><a href="#impl-FromRawFd-for-Epoll%3COwning%3C%27context%2C%20T%3E%3E" class="anchor"></a><h3 class="code-header in-band">impl<'context, T: <a class="trait" href="trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>>> <a class="trait" href="trait.FromRawFd.html" title="trait rustix::fd::FromRawFd">FromRawFd</a> for <a class="struct" href="../io/epoll/struct.Epoll.html" title="struct rustix::io::epoll::Epoll">Epoll</a><<a class="struct" href="../io/epoll/struct.Owning.html" title="struct rustix::io::epoll::Owning">Owning</a><'context, T>></h3></section></div><script type="text/javascript" src="../../implementors/std/os/fd/raw/trait.FromRawFd.js" data-ignore-extern-crates="std" async></script></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> |