103 lines
45 KiB
HTML
103 lines
45 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="The address of a socket."><meta name="keywords" content="rust, rustlang, rust-lang, SockAddr"><title>SockAddr in socket2 - 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 src="../crates.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 struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../socket2/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Struct SockAddr</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.as_ptr">as_ptr</a><a href="#method.as_socket">as_socket</a><a href="#method.as_socket_ipv4">as_socket_ipv4</a><a href="#method.as_socket_ipv6">as_socket_ipv6</a><a href="#method.family">family</a><a href="#method.init">init</a><a href="#method.len">len</a><a href="#method.new">new</a><a href="#method.unix">unix</a><a href="#method.vsock">vsock</a><a href="#method.vsock_address">vsock_address</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CSocketAddr%3E">From<SocketAddr></a><a href="#impl-From%3CSocketAddrV4%3E">From<SocketAddrV4></a><a href="#impl-From%3CSocketAddrV6%3E">From<SocketAddrV6></a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="index.html">socket2</a></h2><div id="sidebar-vars" data-name="SockAddr" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../socket2/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">socket2</a>::<wbr><a class="struct" href="#">SockAddr</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><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/socket2/sockaddr.rs.html#16-19" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct SockAddr { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The address of a socket.</p>
|
||
<p><code>SockAddr</code>s may be constructed directly to and from the standard library
|
||
<a href="https://doc.rust-lang.org/1.59.0/std/net/addr/enum.SocketAddr.html" title="SocketAddr"><code>SocketAddr</code></a>, <a href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV4.html" title="SocketAddrV4"><code>SocketAddrV4</code></a>, and <a href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV6.html" title="SocketAddrV6"><code>SocketAddrV6</code></a> types.</p>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#22-211" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#68-70" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">pub const unsafe fn <a href="#method.new" class="fnname">new</a>(storage: <a class="struct" href="../libc/unix/linux_like/struct.sockaddr_storage.html" title="struct libc::unix::linux_like::sockaddr_storage">sockaddr_storage</a>, len: <a class="type" href="../libc/unix/linux_like/linux/type.socklen_t.html" title="type libc::unix::linux_like::linux::socklen_t">socklen_t</a>) -> <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h4></div></summary><div class="docblock"><p>Create a <code>SockAddr</code> from the underlying storage and its length.</p>
|
||
<h5 id="safety" class="section-header"><a href="#safety">Safety</a></h5>
|
||
<p>Caller must ensure that the address family and length match the type of
|
||
storage address. For example if <code>storage.ss_family</code> is set to <code>AF_INET</code>
|
||
the <code>storage</code> must be initialised as <code>sockaddr_in</code>, setting the content
|
||
and length appropriately.</p>
|
||
<h5 id="examples" class="section-header"><a href="#examples">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::io</span>;
|
||
<span class="kw">use</span> <span class="ident">std::mem</span>;
|
||
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">socket2</span>::{<span class="ident">SockAddr</span>, <span class="ident">Socket</span>, <span class="ident">Domain</span>, <span class="ident">Type</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">Socket::new</span>(<span class="ident">Domain::IPV4</span>, <span class="ident">Type::STREAM</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Initialise a `SocketAddr` byte calling `getsockname(2)`.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">addr_storage</span>: <span class="ident">libc::sockaddr_storage</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">mem::zeroed</span>() };
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">mem::size_of_val</span>(<span class="kw-2">&</span><span class="ident">addr_storage</span>) <span class="kw">as</span> <span class="ident">libc::socklen_t</span>;
|
||
|
||
<span class="comment">// The `getsockname(2)` system call will intiliase `storage` for</span>
|
||
<span class="comment">// us, setting `len` to the correct length.</span>
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">libc::getsockname</span>(
|
||
<span class="ident">socket</span>.<span class="ident">as_raw_fd</span>(),
|
||
(<span class="kw-2">&mut</span> <span class="ident">addr_storage</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">libc::sockaddr_storage</span>).<span class="ident">cast</span>(),
|
||
<span class="kw-2">&mut</span> <span class="ident">len</span>,
|
||
)
|
||
};
|
||
<span class="kw">if</span> <span class="ident">res</span> <span class="op">==</span> <span class="op">-</span><span class="number">1</span> {
|
||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>());
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">address</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">SockAddr::new</span>(<span class="ident">addr_storage</span>, <span class="ident">len</span>) };</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.init" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#117-139" title="goto source code">[src]</a></div><a href="#method.init" class="anchor"></a><h4 class="code-header">pub unsafe fn <a href="#method.init" class="fnname">init</a><F, T>(init: F) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">(</a>T, <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.pointer.html">*mut </a><a class="struct" href="../libc/unix/linux_like/struct.sockaddr_storage.html" title="struct libc::unix::linux_like::sockaddr_storage">sockaddr_storage</a>, <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.pointer.html">*mut </a><a class="type" href="../libc/unix/linux_like/linux/type.socklen_t.html" title="type libc::unix::linux_like::linux::socklen_t">socklen_t</a>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><T>, </span></h4></div></summary><div class="docblock"><p>Initialise a <code>SockAddr</code> by calling the function <code>init</code>.</p>
|
||
<p>The type of the address storage and length passed to the function <code>init</code>
|
||
is OS/architecture specific.</p>
|
||
<p>The address is zeroed before <code>init</code> is called and is thus valid to
|
||
dereference and read from. The length initialised to the maximum length
|
||
of the storage.</p>
|
||
<h5 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h5>
|
||
<p>Caller must ensure that the address family and length match the type of
|
||
storage address. For example if <code>storage.ss_family</code> is set to <code>AF_INET</code>
|
||
the <code>storage</code> must be initialised as <code>sockaddr_in</code>, setting the content
|
||
and length appropriately.</p>
|
||
<h5 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::io</span>;
|
||
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">socket2</span>::{<span class="ident">SockAddr</span>, <span class="ident">Socket</span>, <span class="ident">Domain</span>, <span class="ident">Type</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">Socket::new</span>(<span class="ident">Domain::IPV4</span>, <span class="ident">Type::STREAM</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Initialise a `SocketAddr` byte calling `getsockname(2)`.</span>
|
||
<span class="kw">let</span> (<span class="kw">_</span>, <span class="ident">address</span>) <span class="op">=</span> <span class="kw">unsafe</span> {
|
||
<span class="ident">SockAddr::init</span>(<span class="op">|</span><span class="ident">addr_storage</span>, <span class="ident">len</span><span class="op">|</span> {
|
||
<span class="comment">// The `getsockname(2)` system call will intiliase `storage` for</span>
|
||
<span class="comment">// us, setting `len` to the correct length.</span>
|
||
<span class="kw">if</span> <span class="ident">libc::getsockname</span>(<span class="ident">socket</span>.<span class="ident">as_raw_fd</span>(), <span class="ident">addr_storage</span>.<span class="ident">cast</span>(), <span class="ident">len</span>) <span class="op">==</span> <span class="op">-</span><span class="number">1</span> {
|
||
<span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
|
||
} <span class="kw">else</span> {
|
||
<span class="prelude-val">Ok</span>(())
|
||
}
|
||
})
|
||
}<span class="question-mark">?</span>;</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.family" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#142-144" title="goto source code">[src]</a></div><a href="#method.family" class="anchor"></a><h4 class="code-header">pub const fn <a href="#method.family" class="fnname">family</a>(&self) -> <a class="type" href="../libc/unix/linux_like/type.sa_family_t.html" title="type libc::unix::linux_like::sa_family_t">sa_family_t</a></h4></div></summary><div class="docblock"><p>Returns this address’s family.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.len" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#147-149" title="goto source code">[src]</a></div><a href="#method.len" class="anchor"></a><h4 class="code-header">pub const fn <a href="#method.len" class="fnname">len</a>(&self) -> <a class="type" href="../libc/unix/linux_like/linux/type.socklen_t.html" title="type libc::unix::linux_like::linux::socklen_t">socklen_t</a></h4></div></summary><div class="docblock"><p>Returns the size of this address in bytes.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_ptr" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#152-154" title="goto source code">[src]</a></div><a href="#method.as_ptr" class="anchor"></a><h4 class="code-header">pub const fn <a href="#method.as_ptr" class="fnname">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.pointer.html">*const </a><a class="struct" href="../libc/unix/linux_like/struct.sockaddr.html" title="struct libc::unix::linux_like::sockaddr">sockaddr</a></h4></div></summary><div class="docblock"><p>Returns a raw pointer to the address.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_socket" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#164-192" title="goto source code">[src]</a></div><a href="#method.as_socket" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.as_socket" class="fnname">as_socket</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.59.0/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>></h4></div></summary><div class="docblock"><p>Returns this address as a <code>SocketAddr</code> if it is in the <code>AF_INET</code> (IPv4)
|
||
or <code>AF_INET6</code> (IPv6) family, otherwise returns <code>None</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_socket_ipv4" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#196-201" title="goto source code">[src]</a></div><a href="#method.as_socket_ipv4" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.as_socket_ipv4" class="fnname">as_socket_ipv4</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV4.html" title="struct std::net::addr::SocketAddrV4">SocketAddrV4</a>></h4></div></summary><div class="docblock"><p>Returns this address as a <a href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV4.html" title="SocketAddrV4"><code>SocketAddrV4</code></a> if it is in the <code>AF_INET</code>
|
||
family.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_socket_ipv6" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#205-210" title="goto source code">[src]</a></div><a href="#method.as_socket_ipv6" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.as_socket_ipv6" class="fnname">as_socket_ipv6</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV6.html" title="struct std::net::addr::SocketAddrV6">SocketAddrV6</a>></h4></div></summary><div class="docblock"><p>Returns this address as a <a href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV6.html" title="SocketAddrV6"><code>SocketAddrV6</code></a> if it is in the <code>AF_INET6</code>
|
||
family.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sys/unix.rs.html#444-507" title="goto source code">[src]</a></div><a href="#impl-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="docblock"><p>Unix only API.</p>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.unix" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sys/unix.rs.html#453-506" title="goto source code">[src]</a></div><a href="#method.unix" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.unix" class="fnname">unix</a><P>(path: P) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a>> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>, </span></h4></div></summary><div class="docblock"><p>Constructs a <code>SockAddr</code> with the family <code>AF_UNIX</code> and the provided path.</p>
|
||
<h5 id="failure" class="section-header"><a href="#failure">Failure</a></h5>
|
||
<p>Returns an error if the path is longer than <code>SUN_LEN</code>.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sys/unix.rs.html#509-558" title="goto source code">[src]</a></div><a href="#impl-2" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.vsock" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sys/unix.rs.html#522-540" title="goto source code">[src]</a></div><a href="#method.vsock" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.vsock" class="fnname">vsock</a>(cid: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u32.html">u32</a>, port: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a>></h4></div></summary><div class="docblock"><p>Constructs a <code>SockAddr</code> with the family <code>AF_VSOCK</code> and the provided CID/port.</p>
|
||
<h5 id="errors" class="section-header"><a href="#errors">Errors</a></h5>
|
||
<p>This function can never fail. In a future version of this library it will be made
|
||
infallible.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.vsock_address" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sys/unix.rs.html#549-557" title="goto source code">[src]</a></div><a href="#method.vsock_address" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.vsock_address" class="fnname">vsock_address</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.tuple.html">)</a>></h4></div></summary><div class="docblock"><p>Returns this address VSOCK CID/port if it is in the <code>AF_VSOCK</code> family,
|
||
otherwise return <code>None</code>.</p>
|
||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#291-310" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#292-309" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CSocketAddr%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#213-220" title="goto source code">[src]</a></div><a href="#impl-From%3CSocketAddr%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="https://doc.rust-lang.org/1.59.0/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#214-219" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(addr: <a class="enum" href="https://doc.rust-lang.org/1.59.0/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>) -> <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CSocketAddrV4%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#222-248" title="goto source code">[src]</a></div><a href="#impl-From%3CSocketAddrV4%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV4.html" title="struct std::net::addr::SocketAddrV4">SocketAddrV4</a>> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#223-247" title="goto source code">[src]</a></div><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(addr: <a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV4.html" title="struct std::net::addr::SocketAddrV4">SocketAddrV4</a>) -> <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CSocketAddrV6%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#250-289" title="goto source code">[src]</a></div><a href="#impl-From%3CSocketAddrV6%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV6.html" title="struct std::net::addr::SocketAddrV6">SocketAddrV6</a>> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/socket2/sockaddr.rs.html#251-288" title="goto source code">[src]</a></div><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(addr: <a class="struct" href="https://doc.rust-lang.org/1.59.0/std/net/addr/struct.SocketAddrV6.html" title="struct std::net::addr::SocketAddrV6">SocketAddrV6</a>) -> <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from-3" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from-3" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="socket2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |