blob: ebdcbff029051020be33d73703ca288a2e0e1bf2 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/mio-0.8.8/src/sys/unix/uds/socketaddr.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>socketaddr.rs - source</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" href="../../../../../normalize.css"><link rel="stylesheet" href="../../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../../dark.css" disabled><link rel="stylesheet" href="../../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../../storage.js"></script><script defer src="../../../../../source-script.js"></script><script defer src="../../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../../mio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../../mio/index.html"><img class="rust-logo" src="../../../../../rust-logo.svg" alt="logo"></a><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"><a href="../../../../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::path_offset;
<span class="kw">use </span>std::ffi::OsStr;
<span class="kw">use </span>std::os::unix::ffi::OsStrExt;
<span class="kw">use </span>std::path::Path;
<span class="kw">use </span>std::{ascii, fmt};
<span class="doccomment">/// An address associated with a `mio` specific Unix socket.
///
/// This is implemented instead of imported from [`net::SocketAddr`] because
/// there is no way to create a [`net::SocketAddr`]. One must be returned by
/// [`accept`], so this is returned instead.
///
/// [`net::SocketAddr`]: std::os::unix::net::SocketAddr
/// [`accept`]: #method.accept
</span><span class="kw">pub struct </span>SocketAddr {
sockaddr: libc::sockaddr_un,
socklen: libc::socklen_t,
}
<span class="kw">struct </span>AsciiEscaped&lt;<span class="lifetime">&#39;a</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8]);
<span class="kw">enum </span>AddressKind&lt;<span class="lifetime">&#39;a</span>&gt; {
Unnamed,
Pathname(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Path),
Abstract(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8]),
}
<span class="kw">impl </span>SocketAddr {
<span class="kw">fn </span>address(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; AddressKind&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">let </span>offset = path_offset(<span class="kw-2">&amp;</span><span class="self">self</span>.sockaddr);
<span class="comment">// Don&#39;t underflow in `len` below.
</span><span class="kw">if </span>(<span class="self">self</span>.socklen <span class="kw">as </span>usize) &lt; offset {
<span class="kw">return </span>AddressKind::Unnamed;
}
<span class="kw">let </span>len = <span class="self">self</span>.socklen <span class="kw">as </span>usize - offset;
<span class="kw">let </span>path = <span class="kw">unsafe </span>{ <span class="kw-2">&amp;*</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.sockaddr.sun_path <span class="kw">as </span><span class="kw-2">*const </span>[libc::c_char] <span class="kw">as </span><span class="kw-2">*const </span>[u8]) };
<span class="comment">// macOS seems to return a len of 16 and a zeroed sun_path for unnamed addresses
</span><span class="kw">if </span>len == <span class="number">0
</span>|| (<span class="macro">cfg!</span>(not(any(target_os = <span class="string">&quot;linux&quot;</span>, target_os = <span class="string">&quot;android&quot;</span>)))
&amp;&amp; <span class="self">self</span>.sockaddr.sun_path[<span class="number">0</span>] == <span class="number">0</span>)
{
AddressKind::Unnamed
} <span class="kw">else if </span><span class="self">self</span>.sockaddr.sun_path[<span class="number">0</span>] == <span class="number">0 </span>{
AddressKind::Abstract(<span class="kw-2">&amp;</span>path[<span class="number">1</span>..len])
} <span class="kw">else </span>{
AddressKind::Pathname(OsStr::from_bytes(<span class="kw-2">&amp;</span>path[..len - <span class="number">1</span>]).as_ref())
}
}
}
<span class="macro">cfg_os_poll! </span>{
<span class="kw">use </span>std::{io, mem};
<span class="kw">impl </span>SocketAddr {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new&lt;F&gt;(f: F) -&gt; io::Result&lt;SocketAddr&gt;
<span class="kw">where
</span>F: FnOnce(<span class="kw-2">*mut </span>libc::sockaddr, <span class="kw-2">&amp;mut </span>libc::socklen_t) -&gt; io::Result&lt;libc::c_int&gt;,
{
<span class="kw">let </span><span class="kw-2">mut </span>sockaddr = {
<span class="kw">let </span>sockaddr = mem::MaybeUninit::&lt;libc::sockaddr_un&gt;::zeroed();
<span class="kw">unsafe </span>{ sockaddr.assume_init() }
};
<span class="kw">let </span>raw_sockaddr = <span class="kw-2">&amp;mut </span>sockaddr <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr;
<span class="kw">let </span><span class="kw-2">mut </span>socklen = mem::size_of_val(<span class="kw-2">&amp;</span>sockaddr) <span class="kw">as </span>libc::socklen_t;
f(raw_sockaddr, <span class="kw-2">&amp;mut </span>socklen)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(SocketAddr::from_parts(sockaddr, socklen))
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_parts(sockaddr: libc::sockaddr_un, socklen: libc::socklen_t) -&gt; SocketAddr {
SocketAddr { sockaddr, socklen }
}
<span class="doccomment">/// Returns `true` if the address is unnamed.
///
/// Documentation reflected in [`SocketAddr`]
///
/// [`SocketAddr`]: std::os::unix::net::SocketAddr
</span><span class="kw">pub fn </span>is_unnamed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="macro">matches!</span>(<span class="self">self</span>.address(), AddressKind::Unnamed)
}
<span class="doccomment">/// Returns the contents of this address if it is a `pathname` address.
///
/// Documentation reflected in [`SocketAddr`]
///
/// [`SocketAddr`]: std::os::unix::net::SocketAddr
</span><span class="kw">pub fn </span>as_pathname(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Path&gt; {
<span class="kw">if let </span>AddressKind::Pathname(path) = <span class="self">self</span>.address() {
<span class="prelude-val">Some</span>(path)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the contents of this address if it is an abstract namespace
/// without the leading null byte.
</span><span class="comment">// Link to std::os::unix::net::SocketAddr pending
// https://github.com/rust-lang/rust/issues/85410.
</span><span class="kw">pub fn </span>as_abstract_namespace(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>[u8]&gt; {
<span class="kw">if let </span>AddressKind::Abstract(path) = <span class="self">self</span>.address() {
<span class="prelude-val">Some</span>(path)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SocketAddr {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="kw">match </span><span class="self">self</span>.address() {
AddressKind::Unnamed =&gt; <span class="macro">write!</span>(fmt, <span class="string">&quot;(unnamed)&quot;</span>),
AddressKind::Abstract(name) =&gt; <span class="macro">write!</span>(fmt, <span class="string">&quot;{} (abstract)&quot;</span>, AsciiEscaped(name)),
AddressKind::Pathname(path) =&gt; <span class="macro">write!</span>(fmt, <span class="string">&quot;{:?} (pathname)&quot;</span>, path),
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; fmt::Display <span class="kw">for </span>AsciiEscaped&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="macro">write!</span>(fmt, <span class="string">&quot;\&quot;&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">for </span>byte <span class="kw">in </span><span class="self">self</span>.<span class="number">0</span>.iter().cloned().flat_map(ascii::escape_default) {
<span class="macro">write!</span>(fmt, <span class="string">&quot;{}&quot;</span>, byte <span class="kw">as </span>char)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(fmt, <span class="string">&quot;\&quot;&quot;</span>)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>