23 lines
5.7 KiB
HTML
23 lines
5.7 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."><title>mio::net - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module net</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../mio/index.html">mio</a><span class="version">1.1.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module net</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#notes" title="Notes">Notes</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate mio</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">mio</a></div><h1>Module <span>net</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/mio/net/mod.rs.html#1-39">Source</a> </span></div><details class="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 class="doc-anchor" href="#notes">§</a>Notes</h2>
|
||
<p>When using a datagram based socket, i.e. <a href="struct.UdpSocket.html" title="struct mio::net::UdpSocket"><code>UdpSocket</code></a> or <a href="struct.UnixDatagram.html" title="struct mio::net::UnixDatagram"><code>UnixDatagram</code></a>,
|
||
it’s 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 to handle this. How to deal with these differences 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="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.TcpListener.html" title="struct mio::net::TcpListener">TcpListener</a></dt><dd>A structure representing a socket server</dd><dt><a class="struct" href="struct.TcpStream.html" title="struct mio::net::TcpStream">TcpStream</a></dt><dd>A non-blocking TCP stream between a local socket and a remote socket.</dd><dt><a class="struct" href="struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></dt><dd>A User Datagram Protocol socket.</dd><dt><a class="struct" href="struct.UnixDatagram.html" title="struct mio::net::UnixDatagram">Unix<wbr>Datagram</a></dt><dd>A Unix datagram socket.</dd><dt><a class="struct" href="struct.UnixListener.html" title="struct mio::net::UnixListener">Unix<wbr>Listener</a></dt><dd>A non-blocking Unix domain socket server.</dd><dt><a class="struct" href="struct.UnixStream.html" title="struct mio::net::UnixStream">Unix<wbr>Stream</a></dt><dd>A non-blocking Unix stream socket.</dd></dl></section></div></main></body></html> |