21 lines
21 KiB
HTML
21 lines
21 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 borrow the file descriptor from an underlying object."><meta name="keywords" content="rust, rustlang, rust-lang, AsFd"><title>AsFd in io_lifetimes - 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="../io_lifetimes/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="../io_lifetimes/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">AsFd</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.as_fd">as_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 io_lifetimes</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../io_lifetimes/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">io_lifetimes</a>::<wbr><a class="trait" href="#">AsFd</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.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#200">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 AsFd {
|
||
fn <a href="#tymethod.as_fd" class="fnname">as_fd</a>(&self) -> <a class="struct" href="struct.BorrowedFd.html" title="struct io_lifetimes::BorrowedFd">BorrowedFd</a><'_>;
|
||
}</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 borrow the file descriptor from an underlying object.</p>
|
||
<p>This is only available on unix platforms and must be imported in order to
|
||
call the method. Windows platforms have a corresponding <code>AsHandle</code> and
|
||
<code>AsSocket</code> set of traits.</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.as_fd" class="method has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#219">source</a></div><h4 class="code-header">fn <a href="#tymethod.as_fd" class="fnname">as_fd</a>(&self) -> <a class="struct" href="struct.BorrowedFd.html" title="struct io_lifetimes::BorrowedFd">BorrowedFd</a><'_></h4></div></summary><div class="docblock"><p>Borrows the 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="kw">let</span> <span class="kw-2">mut</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">borrowed_fd</span>: <span class="ident">BorrowedFd</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">as_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-AsFd-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/owned.rs.html#258">source</a></span><a href="#impl-AsFd-for-File" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-for-Stderr" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#128">source</a></span><a href="#impl-AsFd-for-Stderr" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.Stderr.html" title="struct std::io::stdio::Stderr">Stderr</a></h3></section><section id="impl-AsFd-for-Stdin" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#96">source</a></span><a href="#impl-AsFd-for-Stdin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.Stdin.html" title="struct std::io::stdio::Stdin">Stdin</a></h3></section><section id="impl-AsFd-for-Stdout" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#112">source</a></span><a href="#impl-AsFd-for-Stdout" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.Stdout.html" title="struct std::io::stdio::Stdout">Stdout</a></h3></section><section id="impl-AsFd-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/owned.rs.html#308">source</a></span><a href="#impl-AsFd-for-TcpListener" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-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/owned.rs.html#282">source</a></span><a href="#impl-AsFd-for-TcpStream" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-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/owned.rs.html#334">source</a></span><a href="#impl-AsFd-for-UdpSocket" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-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#90">source</a></span><a href="#impl-AsFd-for-PidFd" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-for-UnixDatagram" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/datagram.rs.html#966">source</a></span><a href="#impl-AsFd-for-UnixDatagram" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-for-UnixListener" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/listener.rs.html#304">source</a></span><a href="#impl-AsFd-for-UnixListener" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-for-UnixStream" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/net/stream.rs.html#690">source</a></span><a href="#impl-AsFd-for-UnixStream" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</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-AsFd-for-ChildStderr" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/process.rs.html#446">source</a></span><a href="#impl-AsFd-for-ChildStderr" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/process/struct.ChildStderr.html" title="struct std::process::ChildStderr">ChildStderr</a></h3></section><section id="impl-AsFd-for-ChildStdin" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/process.rs.html#414">source</a></span><a href="#impl-AsFd-for-ChildStdin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/process/struct.ChildStdin.html" title="struct std::process::ChildStdin">ChildStdin</a></h3></section><section id="impl-AsFd-for-ChildStdout" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/unix/process.rs.html#430">source</a></span><a href="#impl-AsFd-for-ChildStdout" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/process/struct.ChildStdout.html" title="struct std::process::ChildStdout">ChildStdout</a></h3></section><section id="impl-AsFd-for-BorrowedFd%3C%27_%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#239">source</a></span><a href="#impl-AsFd-for-BorrowedFd%3C%27_%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="struct.BorrowedFd.html" title="struct io_lifetimes::BorrowedFd">BorrowedFd</a><'_></h3></section><section id="impl-AsFd-for-OwnedFd" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#247">source</a></span><a href="#impl-AsFd-for-OwnedFd" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="struct.OwnedFd.html" title="struct io_lifetimes::OwnedFd">OwnedFd</a></h3></section><section id="impl-AsFd-for-StderrLock%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#136">source</a></span><a href="#impl-AsFd-for-StderrLock%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.StderrLock.html" title="struct std::io::stdio::StderrLock">StderrLock</a><'a></h3></section><section id="impl-AsFd-for-StdinLock%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#104">source</a></span><a href="#impl-AsFd-for-StdinLock%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.StdinLock.html" title="struct std::io::stdio::StdinLock">StdinLock</a><'a></h3></section><section id="impl-AsFd-for-StdoutLock%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/sys/unix/stdio.rs.html#120">source</a></span><a href="#impl-AsFd-for-StdoutLock%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/io/stdio/struct.StdoutLock.html" title="struct std::io::stdio::StdoutLock">StdoutLock</a><'a></h3></section><section id="impl-AsFd-for-%26T" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#223">source</a></span><a href="#impl-AsFd-for-%26T" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a>, </span></h3></section><section id="impl-AsFd-for-%26mut%20T" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#231">source</a></span><a href="#impl-AsFd-for-%26mut%20T" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a>, </span></h3></section><section id="impl-AsFd-for-Box%3CT%2C%20Global%3E" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.64.0">1.64.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#383">source</a></span><a href="#impl-AsFd-for-Box%3CT%2C%20Global%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T, <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a>, </span></h3></section><section id="impl-AsFd-for-Arc%3CT%3E" class="impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.64.0">1.64.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/os/fd/owned.rs.html#375">source</a></span><a href="#impl-AsFd-for-Arc%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.AsFd.html" title="trait io_lifetimes::AsFd">AsFd</a>, </span></h3></section><div class="docblock"><p>This impl allows implementing traits that require <code>AsFd</code> on Arc.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::net::UdpSocket</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::Arc</span>;
|
||
|
||
<span class="kw">trait</span> <span class="ident">MyTrait</span>: <span class="ident">AsFd</span> {}
|
||
<span class="kw">impl</span> <span class="ident">MyTrait</span> <span class="kw">for</span> <span class="ident">Arc</span><span class="op"><</span><span class="ident">UdpSocket</span><span class="op">></span> {}
|
||
<span class="kw">impl</span> <span class="ident">MyTrait</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">UdpSocket</span><span class="op">></span> {}</code></pre></div>
|
||
</div></div><script type="text/javascript" src="../implementors/std/os/fd/owned/trait.AsFd.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="io_lifetimes" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |