blob: 18fb6c4a5a9c192fdb8fa1b8259ac39bd57fff0c [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 `src/sys/unix/uds/socketaddr.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>socketaddr.rs - source</title><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="../../../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../../../storage.js"></script><script src="../../../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><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">&#9776;</div><a href='../../../../../mio/index.html'><div class='logo-container rust-logo'><img src='../../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../../../settings.html"><img src="../../../../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">path_offset</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">OsStr</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">ffi</span>::<span class="ident">OsStrExt</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">ascii</span>, <span class="ident">fmt</span>};
<span class="doccomment">/// An address associated with a `mio` specific Unix socket.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is implemented instead of imported from [`net::SocketAddr`] because</span>
<span class="doccomment">/// there is no way to create a [`net::SocketAddr`]. One must be returned by</span>
<span class="doccomment">/// [`accept`], so this is returned instead.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`net::SocketAddr`]: std::os::unix::net::SocketAddr</span>
<span class="doccomment">/// [`accept`]: #method.accept</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SocketAddr</span> {
<span class="ident">sockaddr</span>: <span class="ident">libc</span>::<span class="ident">sockaddr_un</span>,
<span class="ident">socklen</span>: <span class="ident">libc</span>::<span class="ident">socklen_t</span>,
}
<span class="kw">struct</span> <span class="ident">AsciiEscaped</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> [<span class="ident">u8</span>]);
<span class="kw">enum</span> <span class="ident">AddressKind</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="ident">Unnamed</span>,
<span class="ident">Pathname</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">Path</span>),
<span class="ident">Abstract</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> [<span class="ident">u8</span>]),
}
<span class="kw">impl</span> <span class="ident">SocketAddr</span> {
<span class="kw">fn</span> <span class="ident">address</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">AddressKind</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="ident">path_offset</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">sockaddr</span>);
<span class="comment">// Don&#39;t underflow in `len` below.</span>
<span class="kw">if</span> (<span class="self">self</span>.<span class="ident">socklen</span> <span class="kw">as</span> <span class="ident">usize</span>) <span class="op">&lt;</span> <span class="ident">offset</span> {
<span class="kw">return</span> <span class="ident">AddressKind</span>::<span class="ident">Unnamed</span>;
}
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">socklen</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">-</span> <span class="ident">offset</span>;
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="kw-2">&amp;</span><span class="kw-2">*</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">sockaddr</span>.<span class="ident">sun_path</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="ident">libc</span>::<span class="ident">c_char</span>] <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="ident">u8</span>]) };
<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> <span class="ident">len</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span>
<span class="op">|</span><span class="op">|</span> (<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">not</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;linux&quot;</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;android&quot;</span>)))
<span class="op">&amp;&amp;</span> <span class="self">self</span>.<span class="ident">sockaddr</span>.<span class="ident">sun_path</span>[<span class="number">0</span>] <span class="op">=</span><span class="op">=</span> <span class="number">0</span>)
{
<span class="ident">AddressKind</span>::<span class="ident">Unnamed</span>
} <span class="kw">else</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">sockaddr</span>.<span class="ident">sun_path</span>[<span class="number">0</span>] <span class="op">=</span><span class="op">=</span> <span class="number">0</span> {
<span class="ident">AddressKind</span>::<span class="ident">Abstract</span>(<span class="kw-2">&amp;</span><span class="ident">path</span>[<span class="number">1</span>..<span class="ident">len</span>])
} <span class="kw">else</span> {
<span class="ident">AddressKind</span>::<span class="ident">Pathname</span>(<span class="ident">OsStr</span>::<span class="ident">from_bytes</span>(<span class="kw-2">&amp;</span><span class="ident">path</span>[..<span class="ident">len</span> <span class="op">-</span> <span class="number">1</span>]).<span class="ident">as_ref</span>())
}
}
}
<span class="macro">cfg_os_poll</span><span class="macro">!</span> {
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">io</span>, <span class="ident">mem</span>};
<span class="kw">impl</span> <span class="ident">SocketAddr</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span>(<span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">SocketAddr</span><span class="op">&gt;</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr</span>, <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">socklen_t</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">&gt;</span>,
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sockaddr</span> <span class="op">=</span> {
<span class="kw">let</span> <span class="ident">sockaddr</span> <span class="op">=</span> <span class="ident">mem</span>::<span class="ident">MaybeUninit</span>::<span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">sockaddr_un</span><span class="op">&gt;</span>::<span class="ident">zeroed</span>();
<span class="kw">unsafe</span> { <span class="ident">sockaddr</span>.<span class="ident">assume_init</span>() }
};
<span class="kw">let</span> <span class="ident">raw_sockaddr</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">sockaddr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr_un</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">sockaddr</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">socklen</span> <span class="op">=</span> <span class="ident">mem</span>::<span class="ident">size_of_val</span>(<span class="kw-2">&amp;</span><span class="ident">sockaddr</span>) <span class="kw">as</span> <span class="ident">libc</span>::<span class="ident">socklen_t</span>;
<span class="ident">f</span>(<span class="ident">raw_sockaddr</span>, <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">socklen</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">SocketAddr</span>::<span class="ident">from_parts</span>(<span class="ident">sockaddr</span>, <span class="ident">socklen</span>))
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_parts</span>(<span class="ident">sockaddr</span>: <span class="ident">libc</span>::<span class="ident">sockaddr_un</span>, <span class="ident">socklen</span>: <span class="ident">libc</span>::<span class="ident">socklen_t</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">SocketAddr</span> {
<span class="ident">SocketAddr</span> { <span class="ident">sockaddr</span>, <span class="ident">socklen</span> }
}
<span class="doccomment">/// Returns `true` if the address is unnamed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Documentation reflected in [`SocketAddr`]</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`SocketAddr`]: std::os::unix::net::SocketAddr</span>
<span class="comment">// FIXME: The matches macro requires rust 1.42.0 and we still support 1.39.0</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy</span>::<span class="ident">match_like_matches_macro</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_unnamed</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">AddressKind</span>::<span class="ident">Unnamed</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">address</span>() {
<span class="bool-val">true</span>
} <span class="kw">else</span> {
<span class="bool-val">false</span>
}
}
<span class="doccomment">/// Returns the contents of this address if it is a `pathname` address.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Documentation reflected in [`SocketAddr`]</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`SocketAddr`]: std::os::unix::net::SocketAddr</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_pathname</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">Path</span><span class="op">&gt;</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">AddressKind</span>::<span class="ident">Pathname</span>(<span class="ident">path</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">address</span>() {
<span class="prelude-val">Some</span>(<span class="ident">path</span>)
} <span class="kw">else</span> {
<span class="prelude-val">None</span>
}
}
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">SocketAddr</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">address</span>() {
<span class="ident">AddressKind</span>::<span class="ident">Unnamed</span> <span class="op">=</span><span class="op">&gt;</span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;(unnamed)&quot;</span>),
<span class="ident">AddressKind</span>::<span class="ident">Abstract</span>(<span class="ident">name</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;{} (abstract)&quot;</span>, <span class="ident">AsciiEscaped</span>(<span class="ident">name</span>)),
<span class="ident">AddressKind</span>::<span class="ident">Pathname</span>(<span class="ident">path</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;{:?} (pathname)&quot;</span>, <span class="ident">path</span>),
}
}
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">AsciiEscaped</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;\&quot;&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">for</span> <span class="ident">byte</span> <span class="kw">in</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">iter</span>().<span class="ident">cloned</span>().<span class="ident">flat_map</span>(<span class="ident">ascii</span>::<span class="ident">escape_default</span>) {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;{}&quot;</span>, <span class="ident">byte</span> <span class="kw">as</span> <span class="ident">char</span>)<span class="question-mark">?</span>;
}
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">&quot;\&quot;&quot;</span>)
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mio" data-search-js="../../../../../search-index.js"></div>
<script src="../../../../../main.js"></script><script src="../../../../../source-script.js"></script><script src="../../../../../source-files.js"></script></body></html>