197 lines
9.5 KiB
HTML
197 lines
9.5 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 `net2` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, net2">
|
|||
|
|
|
|||
|
|
<title>net2 - 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="../light.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
<a href='../net2/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
|
|||
|
|
<p class='location'>Crate net2</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'net2', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>net2</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/net2/lib.rs.html#11-121' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Extensions to <code>std::net</code> networking types.</p>
|
|||
|
|
<p>This crate implements a number of extensions to the standard <code>std::net</code>
|
|||
|
|
networking types, hopefully being slated for inclusion into the standard
|
|||
|
|
library in the future. The goal of this crate is to expose all sorts of
|
|||
|
|
cross-platform and platform-specific configuration options of UDP/TCP
|
|||
|
|
sockets. System APIs are wrapped with as thin a layer as possible instead of
|
|||
|
|
bundling multiple actions into one API call.</p>
|
|||
|
|
<p>More information about the design of this crate can be found in the
|
|||
|
|
<a href="https://github.com/rust-lang/rfcs/pull/1158">associated rfc</a></p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">net2</span>::<span class="ident">TcpBuilder</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">tcp</span> <span class="op">=</span> <span class="ident">TcpBuilder</span>::<span class="ident">new_v4</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="ident">tcp</span>.<span class="ident">reuse_address</span>(<span class="bool-val">true</span>).<span class="ident">unwrap</span>()
|
|||
|
|
.<span class="ident">only_v6</span>(<span class="bool-val">false</span>).<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">stream</span> <span class="op">=</span> <span class="ident">tcp</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:80"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// use `stream` as a TcpStream</span></pre>
|
|||
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="unix/index.html"
|
|||
|
|
title='mod net2::unix'>unix</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Unix-specific extensions to the <code>std::net</code> types.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.TcpBuilder.html"
|
|||
|
|
title='struct net2::TcpBuilder'>TcpBuilder</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An "in progress" TCP socket which has not yet been connected or listened.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.UdpBuilder.html"
|
|||
|
|
title='struct net2::UdpBuilder'>UdpBuilder</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An "in progress" UDP socket which has not yet been connected.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.TcpListenerExt.html"
|
|||
|
|
title='trait net2::TcpListenerExt'>TcpListenerExt</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Extension methods for the standard <a href="https://doc.rust-lang.org/std/net/struct.TcpListener.html"><code>TcpListener</code> type</a> in <code>std::net</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.TcpStreamExt.html"
|
|||
|
|
title='trait net2::TcpStreamExt'>TcpStreamExt</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Extension methods for the standard <a href="https://doc.rust-lang.org/std/net/struct.TcpStream.html"><code>TcpStream</code> type</a> in <code>std::net</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.UdpSocketExt.html"
|
|||
|
|
title='trait net2::UdpSocketExt'>UdpSocketExt</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Extension methods for the standard <a href="https://doc.rust-lang.org/std/net/struct.UdpSocket.html"><code>UdpSocket</code> type</a> in <code>std::net</code>.</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 = "net2";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|