blob: 7ed4488f644b00261b22cb01e17ac104fd1a2d01 [file] [log] [blame]
<!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="TCP/UDP/Unix bindings for `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, net"><title>tokio::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">&#9776;</button><a class="sidebar-logo" href="../../tokio/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="../../tokio/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="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</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">tokio</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/tokio/net/mod.rs.html#1-56">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>TCP/UDP/Unix bindings for <code>tokio</code>.</p>
<p>This module contains the TCP/UDP/Unix networking types, similar to the standard
library, which can be used to implement networking protocols.</p>
<h2 id="organization"><a href="#organization">Organization</a></h2>
<ul>
<li><a href="struct.TcpListener.html"><code>TcpListener</code></a> and <a href="struct.TcpStream.html"><code>TcpStream</code></a> provide functionality for communication over TCP</li>
<li><a href="struct.UdpSocket.html"><code>UdpSocket</code></a> provides functionality for communication over UDP</li>
<li><a href="struct.UnixListener.html"><code>UnixListener</code></a> and <a href="struct.UnixStream.html"><code>UnixStream</code></a> provide functionality for communication over a
Unix Domain Stream Socket <strong>(available on Unix only)</strong></li>
<li><a href="struct.UnixDatagram.html"><code>UnixDatagram</code></a> provides functionality for communication
over Unix Domain Datagram Socket <strong>(available on Unix only)</strong></li>
</ul>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="tcp/index.html" title="tokio::net::tcp mod">tcp</a></div><div class="item-right docblock-short">TCP utility types.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="unix/index.html" title="tokio::net::unix mod">unix</a></div><div class="item-right docblock-short">Unix domain socket utility types.</div></div></div><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.TcpListener.html" title="tokio::net::TcpListener struct">TcpListener</a></div><div class="item-right docblock-short">A TCP socket server, listening for connections.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TcpSocket.html" title="tokio::net::TcpSocket struct">TcpSocket</a></div><div class="item-right docblock-short">A TCP socket that has not yet been converted to a <code>TcpStream</code> or
<code>TcpListener</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TcpStream.html" title="tokio::net::TcpStream struct">TcpStream</a></div><div class="item-right docblock-short">A TCP stream between a local and a remote socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UdpSocket.html" title="tokio::net::UdpSocket struct">UdpSocket</a></div><div class="item-right docblock-short">A UDP socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixDatagram.html" title="tokio::net::UnixDatagram struct">UnixDatagram</a></div><div class="item-right docblock-short">An I/O object representing a Unix datagram socket.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixListener.html" title="tokio::net::UnixListener struct">UnixListener</a></div><div class="item-right docblock-short">A Unix socket which can accept connections from other Unix sockets.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixStream.html" title="tokio::net::UnixStream struct">UnixStream</a></div><div class="item-right docblock-short">A structure representing a connected Unix socket.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ToSocketAddrs.html" title="tokio::net::ToSocketAddrs trait">ToSocketAddrs</a></div><div class="item-right docblock-short">Converts or resolves without blocking to one or more <code>SocketAddr</code> values.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.lookup_host.html" title="tokio::net::lookup_host fn">lookup_host</a></div><div class="item-right docblock-short">Performs a DNS resolution.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>