212 lines
9.9 KiB
HTML
212 lines
9.9 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="API documentation for the Rust `net` mod in crate `tokio`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, net">
|
|||
|
|
|
|||
|
|
<title>tokio::net - Rust</title>
|
|||
|
|
|
|||
|
|
<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="../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc mod">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Module net</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>tokio</a></p><script>window.sidebarCurrent = {name: 'net', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>tokio</a>::<wbr><a class="mod" href=''>net</a></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/tokio/net.rs.html#1-41' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>TCP/UDP bindings for <code>tokio</code>.</p>
|
|||
|
|
<p>This module contains the TCP/UDP networking types, similar to the standard
|
|||
|
|
library, which can be used to implement networking protocols.</p>
|
|||
|
|
<h1 id="tcp" class="section-header"><a href="#tcp">TCP</a></h1>
|
|||
|
|
<p>Connecting to an address, via TCP, can be done using <a href="struct.TcpStream.html"><code>TcpStream</code></a>'s
|
|||
|
|
<a href="struct.TcpStream.html#method.connect"><code>connect</code></a> method, which returns <a href="struct.ConnectFuture.html"><code>ConnectFuture</code></a>. <code>ConnectFuture</code>
|
|||
|
|
implements a future which returns a <code>TcpStream</code>.</p>
|
|||
|
|
<p>To listen on an address <a href="struct.TcpListener.html"><code>TcpListener</code></a> can be used. <code>TcpListener</code>'s
|
|||
|
|
<a href="struct.TcpListener.html#method.incoming"><code>incoming</code></a> method can be used to accept new connections.
|
|||
|
|
It return the <a href="struct.Incoming.html"><code>Incoming</code></a> struct, which implements a stream which returns
|
|||
|
|
<code>TcpStream</code>s.</p>
|
|||
|
|
<h1 id="udp" class="section-header"><a href="#udp">UDP</a></h1>
|
|||
|
|
<p>The main struct for UDP is the <a href="struct.UdpSocket.html"><code>UdpSocket</code></a>, which represents a UDP socket.
|
|||
|
|
Reading and writing to it can be done using futures, which return the
|
|||
|
|
<a href="struct.RecvDgram.html"><code>RecvDgram</code></a> and <a href="struct.SendDgram.html"><code>SendDgram</code></a> structs respectively.</p>
|
|||
|
|
<p>For convenience it's also possible to convert raw datagrams into higher-level
|
|||
|
|
frames.</p>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.ConnectFuture.html"
|
|||
|
|
title='struct tokio::net::ConnectFuture'>ConnectFuture</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Future returned by <code>TcpStream::connect</code> which will resolve to a <code>TcpStream</code>
|
|||
|
|
when the stream is connected.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Incoming.html"
|
|||
|
|
title='struct tokio::net::Incoming'>Incoming</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Stream returned by the <code>TcpListener::incoming</code> function representing the
|
|||
|
|
stream of sockets received from a listener.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.RecvDgram.html"
|
|||
|
|
title='struct tokio::net::RecvDgram'>RecvDgram</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A future used to receive a datagram from a UDP socket.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.SendDgram.html"
|
|||
|
|
title='struct tokio::net::SendDgram'>SendDgram</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A future used to write the entire contents of some data to a UDP socket.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.TcpListener.html"
|
|||
|
|
title='struct tokio::net::TcpListener'>TcpListener</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An I/O object representing a TCP socket listening for incoming connections.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.TcpStream.html"
|
|||
|
|
title='struct tokio::net::TcpStream'>TcpStream</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An I/O object representing a TCP stream connected to a remote endpoint.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.UdpFramed.html"
|
|||
|
|
title='struct tokio::net::UdpFramed'>UdpFramed</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A unified <code>Stream</code> and <code>Sink</code> interface to an underlying <code>UdpSocket</code>, using
|
|||
|
|
the <code>Encoder</code> and <code>Decoder</code> traits to encode and decode frames.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.UdpSocket.html"
|
|||
|
|
title='struct tokio::net::UdpSocket'>UdpSocket</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An I/O object representing a UDP socket.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "tokio";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|