| <!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="Networking primitives."><meta name="keywords" content="rust, rustlang, rust-lang, net"><title>mio::net - 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" 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="../../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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../mio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Module net</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../index.html">mio</a>::<wbr><a class="mod" href="#">net</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></h1><span class="out-of-band"><a class="srclink" href="../../src/mio/net/mod.rs.html#1-39">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Networking primitives.</p> |
| <p>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 |
| <a href="../struct.Poll.html#portability">portability guidelines</a> are followed, the behavior should be identical no |
| matter the target platform.</p> |
| <h2 id="notes"><a href="#notes">Notes</a></h2> |
| <p>When using a datagram based socket, i.e. <a href="struct.UdpSocket.html" title="UdpSocket"><code>UdpSocket</code></a> or <a href="struct.UnixDatagram.html" title="UnixDatagram"><code>UnixDatagram</code></a>, |
| 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:</p> |
| <ul> |
| <li>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).</li> |
| <li>Windows returns an <code>WSAEMSGSIZE</code> error.</li> |
| </ul> |
| <p>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 |
| <a href="https://github.com/rust-lang/rust/issues/55794">https://github.com/rust-lang/rust/issues/55794</a>. The best advice we can |
| give is to always call receive with a large enough buffer.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SocketAddr.html" title="mio::net::SocketAddr struct">SocketAddr</a></div><div class="item-right docblock-short">An address associated with a <code>mio</code> specific Unix socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TcpListener.html" title="mio::net::TcpListener struct">TcpListener</a></div><div class="item-right docblock-short">A structure representing a socket server</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TcpStream.html" title="mio::net::TcpStream struct">TcpStream</a></div><div class="item-right docblock-short">A non-blocking TCP stream between a local socket and a remote socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UdpSocket.html" title="mio::net::UdpSocket struct">UdpSocket</a></div><div class="item-right docblock-short">A User Datagram Protocol socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixDatagram.html" title="mio::net::UnixDatagram struct">UnixDatagram</a></div><div class="item-right docblock-short">A Unix datagram socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixListener.html" title="mio::net::UnixListener struct">UnixListener</a></div><div class="item-right docblock-short">A non-blocking Unix domain socket server.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixStream.html" title="mio::net::UnixStream struct">UnixStream</a></div><div class="item-right docblock-short">A non-blocking Unix stream socket.</div></div></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> |
