NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-16 16:03:48 +00:00
Code Issues Projects Releases Packages Wiki Activity
mpvrc/rustix/fd/trait.IntoRawFd.html

21 lines
No EOL
14 KiB
HTML
Raw 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="A trait to express the ability to consume an object and acquire ownership of its raw file descriptor."><title>IntoRawFd in rustix::fd - 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 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" 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="#">Into<wbr>RawFd</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_raw_fd" title="into_raw_fd">into_raw_fd</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>fd</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">fd</a></span><h1>Trait <span class="trait">IntoRawFd</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/raw.rs.html#117">Source</a> </span></div><pre class="rust item-decl"><code>pub trait IntoRawFd {
// Required method
fn <a href="#tymethod.into_raw_fd" class="fn">into_raw_fd</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.i32.html">i32</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait to express the ability to consume an object and acquire ownership of
its raw file descriptor.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.into_raw_fd" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/raw.rs.html#143">Source</a></span><h4 class="code-header">fn <a href="#tymethod.into_raw_fd" class="fn">into_raw_fd</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.i32.html">i32</a></h4></section></summary><div class="docblock"><p>Consumes this object, returning the raw underlying file descriptor.</p>
<p>This function is typically used to <strong>transfer ownership</strong> of the underlying
file descriptor to the caller. When used in this way, callers are then the unique
owners of the file descriptor and must close it once it’s no longer needed.</p>
<p>However, transferring ownership is not strictly required. Use a
<a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html#tymethod.into" title="method core::convert::Into::into"><code>Into&lt;OwnedFd&gt;::into</code></a> implementation for an API which strictly
transfers ownership.</p>
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::fs::File;
<span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
</span><span class="kw">use </span>std::os::fd::{IntoRawFd, RawFd};
<span class="kw">let </span>f = File::open(<span class="string">"foo.txt"</span>)<span class="question-mark">?</span>;
<span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
</span><span class="kw">let </span>raw_fd: RawFd = f.into_raw_fd();</code></pre></div>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-IntoRawFd-for-i32" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.48.0">1.48.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/raw.rs.html#154">Source</a></span><a href="#impl-IntoRawFd-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.i32.html">i32</a></h3></section><section id="impl-IntoRawFd-for-File" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/raw.rs.html#183">Source</a></span><a href="#impl-IntoRawFd-for-File" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/fs/struct.File.html" title="struct std::fs::File">File</a></h3></section><section id="impl-IntoRawFd-for-TcpListener" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/net.rs.html#46">Source</a></span><a href="#impl-IntoRawFd-for-TcpListener" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a></h3></section><section id="impl-IntoRawFd-for-TcpStream" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/net.rs.html#46">Source</a></span><a href="#impl-IntoRawFd-for-TcpStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/net/tcp/struct.TcpStream.html" title="struct std::net::tcp::TcpStream">TcpStream</a></h3></section><section id="impl-IntoRawFd-for-UdpSocket" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/net.rs.html#46">Source</a></span><a href="#impl-IntoRawFd-for-UdpSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a></h3></section><section id="impl-IntoRawFd-for-PidFd" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/std/os/linux/process.rs.html#121">Source</a><a href="#impl-IntoRawFd-for-PidFd" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/os/linux/process/struct.PidFd.html" title="struct std::os::linux::process::PidFd">PidFd</a></h3></section><section id="impl-IntoRawFd-for-UnixDatagram" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/net/datagram.rs.html#956">Source</a></span><a href="#impl-IntoRawFd-for-UnixDatagram" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/os/unix/net/datagram/struct.UnixDatagram.html" title="struct std::os::unix::net::datagram::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-IntoRawFd-for-UnixListener" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/net/listener.rs.html#328">Source</a></span><a href="#impl-IntoRawFd-for-UnixListener" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/os/unix/net/listener/struct.UnixListener.html" title="struct std::os::unix::net::listener::UnixListener">UnixListener</a></h3></section><section id="impl-IntoRawFd-for-UnixStream" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/net/stream.rs.html#669">Source</a></span><a href="#impl-IntoRawFd-for-UnixStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/os/unix/net/stream/struct.UnixStream.html" title="struct std::os::unix::net::stream::UnixStream">UnixStream</a></h3></section><section id="impl-IntoRawFd-for-PipeReader" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/std/sys/anonymous_pipe/unix.rs.html#41">Source</a><a href="#impl-IntoRawFd-for-PipeReader" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/pipe/struct.PipeReader.html" title="struct std::pipe::PipeReader">PipeReader</a></h3></section><section id="impl-IntoRawFd-for-PipeWriter" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/std/sys/anonymous_pipe/unix.rs.html#78">Source</a><a href="#impl-IntoRawFd-for-PipeWriter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/pipe/struct.PipeWriter.html" title="struct std::pipe::PipeWriter">PipeWriter</a></h3></section><section id="impl-IntoRawFd-for-ChildStderr" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/process.rs.html#426">Source</a></span><a href="#impl-IntoRawFd-for-ChildStderr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/process/struct.ChildStderr.html" title="struct std::process::ChildStderr">ChildStderr</a></h3></section><section id="impl-IntoRawFd-for-ChildStdin" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/process.rs.html#410">Source</a></span><a href="#impl-IntoRawFd-for-ChildStdin" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/process/struct.ChildStdin.html" title="struct std::process::ChildStdin">ChildStdin</a></h3></section><section id="impl-IntoRawFd-for-ChildStdout" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/unix/process.rs.html#418">Source</a></span><a href="#impl-IntoRawFd-for-ChildStdout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/process/struct.ChildStdout.html" title="struct std::process::ChildStdout">ChildStdout</a></h3></section><section id="impl-IntoRawFd-for-OwnedFd" class="impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.63.0">1.63.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.1/src/std/os/fd/owned.rs.html#146">Source</a></span><a href="#impl-IntoRawFd-for-OwnedFd" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoRawFd.html" title="trait rustix::fd::IntoRawFd">IntoRawFd</a> for <a class="struct" href="struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a></h3></section></div><script src="../../trait.impl/std/os/fd/raw/trait.IntoRawFd.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink