| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/net/uds/datagram.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>datagram.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> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource; |
| <span class="kw">use crate</span>::{event, sys, Interest, Registry, Token}; |
| |
| <span class="kw">use </span>std::net::Shutdown; |
| <span class="kw">use </span>std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}; |
| <span class="kw">use </span>std::os::unix::net; |
| <span class="kw">use </span>std::path::Path; |
| <span class="kw">use </span>std::{fmt, io}; |
| |
| <span class="doccomment">/// A Unix datagram socket. |
| </span><span class="kw">pub struct </span>UnixDatagram { |
| inner: IoSource<net::UnixDatagram>, |
| } |
| |
| <span class="kw">impl </span>UnixDatagram { |
| <span class="doccomment">/// Creates a Unix datagram socket bound to the given path. |
| </span><span class="kw">pub fn </span>bind<P: AsRef<Path>>(path: P) -> io::Result<UnixDatagram> { |
| sys::uds::datagram::bind(path.as_ref()).map(UnixDatagram::from_std) |
| } |
| |
| <span class="doccomment">/// Creates a new `UnixDatagram` from a standard `net::UnixDatagram`. |
| /// |
| /// This function is intended to be used to wrap a Unix datagram from the |
| /// standard library in the Mio equivalent. The conversion assumes nothing |
| /// about the underlying datagram; it is left up to the user to set it in |
| /// non-blocking mode. |
| </span><span class="kw">pub fn </span>from_std(socket: net::UnixDatagram) -> UnixDatagram { |
| UnixDatagram { |
| inner: IoSource::new(socket), |
| } |
| } |
| |
| <span class="doccomment">/// Connects the socket to the specified address. |
| /// |
| /// This may return a `WouldBlock` in which case the socket connection |
| /// cannot be completed immediately. |
| </span><span class="kw">pub fn </span>connect<P: AsRef<Path>>(<span class="kw-2">&</span><span class="self">self</span>, path: P) -> io::Result<()> { |
| <span class="self">self</span>.inner.connect(path) |
| } |
| |
| <span class="doccomment">/// Creates a Unix Datagram socket which is not bound to any address. |
| </span><span class="kw">pub fn </span>unbound() -> io::Result<UnixDatagram> { |
| sys::uds::datagram::unbound().map(UnixDatagram::from_std) |
| } |
| |
| <span class="doccomment">/// Create an unnamed pair of connected sockets. |
| </span><span class="kw">pub fn </span>pair() -> io::Result<(UnixDatagram, UnixDatagram)> { |
| sys::uds::datagram::pair().map(|(socket1, socket2)| { |
| ( |
| UnixDatagram::from_std(socket1), |
| UnixDatagram::from_std(socket2), |
| ) |
| }) |
| } |
| |
| <span class="doccomment">/// Returns the address of this socket. |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<sys::SocketAddr> { |
| sys::uds::datagram::local_addr(<span class="kw-2">&</span><span class="self">self</span>.inner) |
| } |
| |
| <span class="doccomment">/// Returns the address of this socket's peer. |
| /// |
| /// The `connect` method will connect the socket to a peer. |
| </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<sys::SocketAddr> { |
| sys::uds::datagram::peer_addr(<span class="kw-2">&</span><span class="self">self</span>.inner) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket. |
| /// |
| /// On success, returns the number of bytes read and the address from |
| /// whence the data came. |
| </span><span class="kw">pub fn </span>recv_from(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<(usize, sys::SocketAddr)> { |
| <span class="self">self</span>.inner |
| .do_io(|inner| sys::uds::datagram::recv_from(inner, buf)) |
| } |
| |
| <span class="doccomment">/// Receives data from the socket. |
| /// |
| /// On success, returns the number of bytes read. |
| </span><span class="kw">pub fn </span>recv(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.recv(buf)) |
| } |
| |
| <span class="doccomment">/// Sends data on the socket to the specified address. |
| /// |
| /// On success, returns the number of bytes written. |
| </span><span class="kw">pub fn </span>send_to<P: AsRef<Path>>(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8], path: P) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.send_to(buf, path)) |
| } |
| |
| <span class="doccomment">/// Sends data on the socket to the socket's peer. |
| /// |
| /// The peer address may be set by the `connect` method, and this method |
| /// will return an error if the socket has not already been connected. |
| /// |
| /// On success, returns the number of bytes written. |
| </span><span class="kw">pub fn </span>send(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|inner| inner.send(buf)) |
| } |
| |
| <span class="doccomment">/// Returns the value of the `SO_ERROR` option. |
| </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<<span class="prelude-ty">Option</span><io::Error>> { |
| <span class="self">self</span>.inner.take_error() |
| } |
| |
| <span class="doccomment">/// Shut down the read, write, or both halves of this connection. |
| /// |
| /// This function will cause all pending and future I/O calls on the |
| /// specified portions to immediately return with an appropriate value |
| /// (see the documentation of `Shutdown`). |
| </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&</span><span class="self">self</span>, how: Shutdown) -> io::Result<()> { |
| <span class="self">self</span>.inner.shutdown(how) |
| } |
| |
| <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events |
| /// if it hits a [`WouldBlock`] error. |
| /// |
| /// # Notes |
| /// |
| /// This method is required to be called for **all** I/O operations to |
| /// ensure the user will receive events once the socket is ready again after |
| /// returning a [`WouldBlock`] error. |
| /// |
| /// [`WouldBlock`]: io::ErrorKind::WouldBlock |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use std::io; |
| /// use std::os::unix::io::AsRawFd; |
| /// use mio::net::UnixDatagram; |
| /// |
| /// let (dgram1, dgram2) = UnixDatagram::pair()?; |
| /// |
| /// // Wait until the dgram is writable... |
| /// |
| /// // Write to the dgram using a direct libc call, of course the |
| /// // `io::Write` implementation would be easier to use. |
| /// let buf = b"hello"; |
| /// let n = dgram1.try_io(|| { |
| /// let buf_ptr = &buf as *const _ as *const _; |
| /// let res = unsafe { libc::send(dgram1.as_raw_fd(), buf_ptr, buf.len(), 0) }; |
| /// if res != -1 { |
| /// Ok(res as usize) |
| /// } else { |
| /// // If EAGAIN or EWOULDBLOCK is set by libc::send, the closure |
| /// // should return `WouldBlock` error. |
| /// Err(io::Error::last_os_error()) |
| /// } |
| /// })?; |
| /// eprintln!("write {} bytes", n); |
| /// |
| /// // Wait until the dgram is readable... |
| /// |
| /// // Read from the dgram using a direct libc call, of course the |
| /// // `io::Read` implementation would be easier to use. |
| /// let mut buf = [0; 512]; |
| /// let n = dgram2.try_io(|| { |
| /// let buf_ptr = &mut buf as *mut _ as *mut _; |
| /// let res = unsafe { libc::recv(dgram2.as_raw_fd(), buf_ptr, buf.len(), 0) }; |
| /// if res != -1 { |
| /// Ok(res as usize) |
| /// } else { |
| /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure |
| /// // should return `WouldBlock` error. |
| /// Err(io::Error::last_os_error()) |
| /// } |
| /// })?; |
| /// eprintln!("read {} bytes", n); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>try_io<F, T>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> io::Result<T> |
| <span class="kw">where |
| </span>F: FnOnce() -> io::Result<T>, |
| { |
| <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f()) |
| } |
| } |
| |
| <span class="kw">impl </span>event::Source <span class="kw">for </span>UnixDatagram { |
| <span class="kw">fn </span>register( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.register(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>reregister( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.reregister(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>deregister(<span class="kw-2">&mut </span><span class="self">self</span>, registry: <span class="kw-2">&</span>Registry) -> io::Result<()> { |
| <span class="self">self</span>.inner.deregister(registry) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UnixDatagram { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="self">self</span>.inner.fmt(f) |
| } |
| } |
| |
| <span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UnixDatagram { |
| <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.into_inner().into_raw_fd() |
| } |
| } |
| |
| <span class="kw">impl </span>AsRawFd <span class="kw">for </span>UnixDatagram { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.as_raw_fd() |
| } |
| } |
| |
| <span class="kw">impl </span>FromRawFd <span class="kw">for </span>UnixDatagram { |
| <span class="doccomment">/// Converts a `RawFd` to a `UnixDatagram`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -> UnixDatagram { |
| UnixDatagram::from_std(FromRawFd::from_raw_fd(fd)) |
| } |
| } |
| </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> |
