| <!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Networking primitives. |
| //! |
| //! The types provided in this module are non-blocking by default and are |
| //! designed to be portable across all supported Mio platforms. As long as the |
| //! [portability guidelines] are followed, the behavior should be identical no |
| //! matter the target platform. |
| //! |
| //! [portability guidelines]: ../struct.Poll.html#portability |
| //! |
| //! # Notes |
| //! |
| //! When using a datagram based socket, i.e. [`UdpSocket`] or [`UnixDatagram`], |
| //! its only possible to receive a packet once. This means that if you provide a |
| //! buffer that is too small you won't be able to receive the data anymore. How |
| //! OSs deal with this situation is different for each OS: |
| //! * Unixes, such as Linux, FreeBSD and macOS, will simply fill the buffer and |
| //! return the amount of bytes written. This means that if the returned value |
| //! is equal to the size of the buffer it may have only written a part of the |
| //! packet (or the packet has the same size as the buffer). |
| //! * Windows returns an `WSAEMSGSIZE` error. |
| //! |
| //! Mio does not change the value (either ok or error) returned by the OS, it's |
| //! up to the user handle this. How to deal with these difference is still up |
| //! for debate, specifically in |
| //! <https://github.com/rust-lang/rust/issues/55794>. The best advice we can |
| //! give is to always call receive with a large enough buffer. |
| |
| </span><span class="kw">mod </span>tcp; |
| <span class="kw">pub use </span><span class="self">self</span>::tcp::{TcpListener, TcpStream}; |
| |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">mod </span>udp; |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::udp::UdpSocket; |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">mod </span>uds; |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">pub use </span><span class="self">self</span>::uds::{SocketAddr, UnixDatagram, UnixListener, UnixStream}; |
| </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> |
