100 lines
39 KiB
HTML
100 lines
39 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 Unix socket that has not yet been converted to a `UnixStream`, `UnixDatagram`, or `UnixListener`."><title>UnixSocket in tokio::net - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">UnixSocket</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Unix<wbr>Socket</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.bind" title="bind">bind</a></li><li><a href="#method.connect" title="connect">connect</a></li><li><a href="#method.datagram" title="datagram">datagram</a></li><li><a href="#method.listen" title="listen">listen</a></li><li><a href="#method.new_datagram" title="new_datagram">new_datagram</a></li><li><a href="#method.new_stream" title="new_stream">new_stream</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-AsFd-for-UnixSocket" title="AsFd">AsFd</a></li><li><a href="#impl-AsRawFd-for-UnixSocket" title="AsRawFd">AsRawFd</a></li><li><a href="#impl-Debug-for-UnixSocket" title="Debug">Debug</a></li><li><a href="#impl-FromRawFd-for-UnixSocket" title="FromRawFd">FromRawFd</a></li><li><a href="#impl-IntoRawFd-for-UnixSocket" title="IntoRawFd">IntoRawFd</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-UnixSocket" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-UnixSocket" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-UnixSocket" title="Send">Send</a></li><li><a href="#impl-Sync-for-UnixSocket" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-UnixSocket" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-UnixSocket" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>net</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">tokio</a>::<wbr><a href="index.html">net</a></div><h1>Struct <span class="struct">Unix<wbr>Socket</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/tokio/net/unix/socket.rs.html#89-91">Source</a> </span></div><pre class="rust item-decl"><code>pub struct UnixSocket { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A Unix socket that has not yet been converted to a <a href="struct.UnixStream.html" title="struct tokio::net::UnixStream"><code>UnixStream</code></a>, <a href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram"><code>UnixDatagram</code></a>, or
|
|
<a href="struct.UnixListener.html" title="struct tokio::net::UnixListener"><code>UnixListener</code></a>.</p>
|
|
<p><code>UnixSocket</code> wraps an operating system socket and enables the caller to
|
|
configure the socket before establishing a connection or accepting
|
|
inbound connections. The caller is able to set socket option and explicitly
|
|
bind the socket with a socket address.</p>
|
|
<p>The underlying socket is closed when the <code>UnixSocket</code> value is dropped.</p>
|
|
<p><code>UnixSocket</code> should only be used directly if the default configuration used
|
|
by <a href="struct.UnixStream.html#method.connect" title="associated function tokio::net::UnixStream::connect"><code>UnixStream::connect</code></a>, <a href="struct.UnixDatagram.html#method.bind" title="associated function tokio::net::UnixDatagram::bind"><code>UnixDatagram::bind</code></a>, and <a href="struct.UnixListener.html#method.bind" title="associated function tokio::net::UnixListener::bind"><code>UnixListener::bind</code></a>
|
|
does not meet the required use case.</p>
|
|
<p>Calling <code>UnixStream::connect(path)</code> effectively performs the same function as:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixSocket;
|
|
<span class="kw">use </span>std::error::Error;
|
|
|
|
<span class="attr">#[tokio::main]
|
|
</span><span class="kw">async fn </span>main() -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>Error>> {
|
|
<span class="kw">let </span>dir = tempfile::tempdir().unwrap();
|
|
<span class="kw">let </span>path = dir.path().join(<span class="string">"bind_path"</span>);
|
|
<span class="kw">let </span>socket = UnixSocket::new_stream()<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>stream = socket.connect(path).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
|
|
<span class="prelude-val">Ok</span>(())
|
|
}</code></pre></div>
|
|
<p>Calling <code>UnixDatagram::bind(path)</code> effectively performs the same function as:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixSocket;
|
|
<span class="kw">use </span>std::error::Error;
|
|
|
|
<span class="attr">#[tokio::main]
|
|
</span><span class="kw">async fn </span>main() -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>Error>> {
|
|
<span class="kw">let </span>dir = tempfile::tempdir().unwrap();
|
|
<span class="kw">let </span>path = dir.path().join(<span class="string">"bind_path"</span>);
|
|
<span class="kw">let </span>socket = UnixSocket::new_datagram()<span class="question-mark">?</span>;
|
|
socket.bind(path)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>datagram = socket.datagram()<span class="question-mark">?</span>;
|
|
|
|
<span class="prelude-val">Ok</span>(())
|
|
}</code></pre></div>
|
|
<p>Calling <code>UnixListener::bind(path)</code> effectively performs the same function as:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixSocket;
|
|
<span class="kw">use </span>std::error::Error;
|
|
|
|
<span class="attr">#[tokio::main]
|
|
</span><span class="kw">async fn </span>main() -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>Error>> {
|
|
<span class="kw">let </span>dir = tempfile::tempdir().unwrap();
|
|
<span class="kw">let </span>path = dir.path().join(<span class="string">"bind_path"</span>);
|
|
<span class="kw">let </span>socket = UnixSocket::new_stream()<span class="question-mark">?</span>;
|
|
socket.bind(path)<span class="question-mark">?</span>;
|
|
|
|
<span class="kw">let </span>listener = socket.listen(<span class="number">1024</span>)<span class="question-mark">?</span>;
|
|
|
|
<span class="prelude-val">Ok</span>(())
|
|
}</code></pre></div>
|
|
<p>Setting socket options not explicitly provided by <code>UnixSocket</code> may be done by
|
|
accessing the <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd"><code>RawFd</code></a>/<a href="https://doc.rust-lang.org/std/os/windows/io/type.RawSocket.html"><code>RawSocket</code></a> using <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.AsRawFd.html" title="trait std::os::fd::raw::AsRawFd"><code>AsRawFd</code></a>/<a href="https://doc.rust-lang.org/std/os/windows/io/trait.AsRawSocket.html"><code>AsRawSocket</code></a> and
|
|
setting the option with a crate like <a href="https://docs.rs/socket2/"><code>socket2</code></a>.</p>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#94-246">Source</a><a href="#impl-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new_datagram" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#107-109">Source</a><h4 class="code-header">pub fn <a href="#method.new_datagram" class="fn">new_datagram</a>() -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a>></h4></section></summary><div class="docblock"><p>Creates a new Unix datagram socket.</p>
|
|
<p>Calls <code>socket(2)</code> with <code>AF_UNIX</code> and <code>SOCK_DGRAM</code>.</p>
|
|
<h5 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h5>
|
|
<p>On success, the newly created <a href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket"><code>UnixSocket</code></a> is returned. If an error is
|
|
encountered, it is returned instead.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.new_stream" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#119-121">Source</a><h4 class="code-header">pub fn <a href="#method.new_stream" class="fn">new_stream</a>() -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a>></h4></section></summary><div class="docblock"><p>Creates a new Unix stream socket.</p>
|
|
<p>Calls <code>socket(2)</code> with <code>AF_UNIX</code> and <code>SOCK_STREAM</code>.</p>
|
|
<h5 id="returns-1"><a class="doc-anchor" href="#returns-1">§</a>Returns</h5>
|
|
<p>On success, the newly created <a href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket"><code>UnixSocket</code></a> is returned. If an error is
|
|
encountered, it is returned instead.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bind" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#153-156">Source</a><h4 class="code-header">pub fn <a href="#method.bind" class="fn">bind</a>(&self, path: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Binds the socket to the given address.</p>
|
|
<p>This calls the <code>bind(2)</code> operating-system function.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.listen" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#171-188">Source</a><h4 class="code-header">pub fn <a href="#method.listen" class="fn">listen</a>(self, backlog: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.UnixListener.html" title="struct tokio::net::UnixListener">UnixListener</a>></h4></section></summary><div class="docblock"><p>Converts the socket into a <code>UnixListener</code>.</p>
|
|
<p><code>backlog</code> defines the maximum number of pending connections are queued
|
|
by the operating system at any given time. Connection are removed from
|
|
the queue with <a href="struct.UnixListener.html#method.accept" title="method tokio::net::UnixListener::accept"><code>UnixListener::accept</code></a>. When the queue is full, the
|
|
operating-system will start rejecting connections.</p>
|
|
<p>Calling this function on a socket created by <a href="struct.UnixSocket.html#method.new_datagram" title="associated function tokio::net::UnixSocket::new_datagram"><code>new_datagram</code></a> will return an error.</p>
|
|
<p>This calls the <code>listen(2)</code> operating-system function, marking the socket
|
|
as a passive socket.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.connect" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#201-223">Source</a><h4 class="code-header">pub async fn <a href="#method.connect" class="fn">connect</a>(self, path: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.UnixStream.html" title="struct tokio::net::UnixStream">UnixStream</a>></h4></section></summary><div class="docblock"><p>Establishes a Unix connection with a peer at the specified socket address.</p>
|
|
<p>The <code>UnixSocket</code> is consumed. Once the connection is established, a
|
|
connected <a href="struct.UnixStream.html" title="struct tokio::net::UnixStream"><code>UnixStream</code></a> is returned. If the connection fails, the
|
|
encountered error is returned.</p>
|
|
<p>Calling this function on a socket created by <a href="struct.UnixSocket.html#method.new_datagram" title="associated function tokio::net::UnixSocket::new_datagram"><code>new_datagram</code></a> will return an error.</p>
|
|
<p>This calls the <code>connect(2)</code> operating-system function.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.datagram" class="method"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#230-245">Source</a><h4 class="code-header">pub fn <a href="#method.datagram" class="fn">datagram</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>></h4></section></summary><div class="docblock"><p>Converts the socket into a <a href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram"><code>UnixDatagram</code></a>.</p>
|
|
<p>Calling this function on a socket created by <a href="struct.UnixSocket.html#method.new_stream" title="associated function tokio::net::UnixSocket::new_stream"><code>new_stream</code></a> will return an error.</p>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AsFd-for-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#254-258">Source</a><a href="#impl-AsFd-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/trait.AsFd.html" title="trait std::os::fd::owned::AsFd">AsFd</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_fd" class="method trait-impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#255-257">Source</a><a href="#method.as_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd" class="fn">as_fd</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.BorrowedFd.html" title="struct std::os::fd::owned::BorrowedFd">BorrowedFd</a><'_></h4></section></summary><div class='docblock'>Borrows the file descriptor. <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsRawFd-for-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#248-252">Source</a><a href="#impl-AsRawFd-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.AsRawFd.html" title="trait std::os::fd::raw::AsRawFd">AsRawFd</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_raw_fd" class="method trait-impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#249-251">Source</a><a href="#method.as_raw_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd" class="fn">as_raw_fd</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd">RawFd</a></h4></section></summary><div class='docblock'>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#88">Source</a><a href="#impl-Debug-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#88">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FromRawFd-for-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#260-267">Source</a><a href="#impl-FromRawFd-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.FromRawFd.html" title="trait std::os::fd::raw::FromRawFd">FromRawFd</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_raw_fd" class="method trait-impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#261-266">Source</a><a href="#method.from_raw_fd" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.FromRawFd.html#tymethod.from_raw_fd" class="fn">from_raw_fd</a>(fd: <a class="type" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd">RawFd</a>) -> <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h4></section></summary><div class='docblock'>Constructs a new instance of <code>Self</code> from the given raw file
|
|
descriptor. <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.FromRawFd.html#tymethod.from_raw_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoRawFd-for-UnixSocket" class="impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#269-273">Source</a><a href="#impl-IntoRawFd-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.IntoRawFd.html" title="trait std::os::fd::raw::IntoRawFd">IntoRawFd</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_raw_fd" class="method trait-impl"><a class="src rightside" href="../../src/tokio/net/unix/socket.rs.html#270-272">Source</a><a href="#method.into_raw_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.IntoRawFd.html#tymethod.into_raw_fd" class="fn">into_raw_fd</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd">RawFd</a></h4></section></summary><div class='docblock'>Consumes this object, returning the raw underlying file descriptor. <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.IntoRawFd.html#tymethod.into_raw_fd">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-UnixSocket" class="impl"><a href="#impl-Freeze-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section><section id="impl-RefUnwindSafe-for-UnixSocket" class="impl"><a href="#impl-RefUnwindSafe-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section><section id="impl-Send-for-UnixSocket" class="impl"><a href="#impl-Send-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section><section id="impl-Sync-for-UnixSocket" class="impl"><a href="#impl-Sync-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section><section id="impl-Unpin-for-UnixSocket" class="impl"><a href="#impl-Unpin-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section><section id="impl-UnwindSafe-for-UnixSocket" class="impl"><a href="#impl-UnwindSafe-for-UnixSocket" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.UnixSocket.html" title="struct tokio::net::UnixSocket">UnixSocket</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |