34 lines
7.8 KiB
HTML
34 lines
7.8 KiB
HTML
<!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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../mio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Module net</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><div id="sidebar-vars" data-name="net" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../mio/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">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></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/mio/net/mod.rs.html#1-39" title="goto source code">[src]</a></span></h1><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" class="section-header"><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"><p>An address associated with a <code>mio</code> specific Unix socket.</p>
|
||
</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"><p>A structure representing a socket server</p>
|
||
</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"><p>A non-blocking TCP stream between a local socket and a remote socket.</p>
|
||
</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"><p>A User Datagram Protocol socket.</p>
|
||
</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"><p>A Unix datagram socket.</p>
|
||
</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"><p>A non-blocking Unix domain socket server.</p>
|
||
</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"><p>A non-blocking Unix stream socket.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></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.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |