Initial docs commit
This commit is contained in:
Uttarayan Mondal
@@ -0,0 +1,32 @@
|
||||
<!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="Utilities for handling sockets"><meta name="keywords" content="rust, rustlang, rust-lang, socket2"><title>socket2 - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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='../socket2/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate socket2</p><div class="block version"><p>Version 0.3.19</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all socket2's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="socket2" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">socket2</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/socket2/lib.rs.html#11-230" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Utilities for handling sockets</p>
|
||||
<p>This crate is sort of an evolution of the <code>net2</code> crate after seeing the
|
||||
issues on it over time. The intention of this crate is to provide as direct
|
||||
as possible access to the system’s functionality for sockets as possible. No
|
||||
extra fluff (e.g. multiple syscalls or builders) provided in this crate. As
|
||||
a result using this crate can be a little wordy, but it should give you
|
||||
maximal flexibility over configuration of sockets.</p>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span>;
|
||||
<span class="kw">use</span> <span class="ident">socket2</span>::{<span class="ident">Socket</span>, <span class="ident">Domain</span>, <span class="ident">Type</span>};
|
||||
|
||||
<span class="comment">// create a TCP listener bound to two addresses</span>
|
||||
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">Socket</span>::<span class="ident">new</span>(<span class="ident">Domain</span>::<span class="ident">ipv6</span>(), <span class="ident">Type</span>::<span class="ident">stream</span>(), <span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="ident">socket</span>.<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"[::1]:12345"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>().<span class="ident">into</span>()).<span class="ident">unwrap</span>();
|
||||
<span class="ident">socket</span>.<span class="ident">set_only_v6</span>(<span class="bool-val">false</span>);
|
||||
<span class="ident">socket</span>.<span class="ident">listen</span>(<span class="number">128</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">listener</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">into_tcp_listener</span>();
|
||||
<span class="comment">// ...</span></pre></div>
|
||||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||||
<table><tr class="module-item"><td><a class="struct" href="struct.Domain.html" title="socket2::Domain struct">Domain</a></td><td class="docblock-short"><p>Specification of the communication domain for a socket.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Protocol.html" title="socket2::Protocol struct">Protocol</a></td><td class="docblock-short"><p>Protocol specification used for creating sockets via <code>Socket::new</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SockAddr.html" title="socket2::SockAddr struct">SockAddr</a></td><td class="docblock-short"><p>The address of a socket.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Socket.html" title="socket2::Socket struct">Socket</a></td><td class="docblock-short"><p>Newtype, owned, wrapper around a system socket.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Type.html" title="socket2::Type struct">Type</a></td><td class="docblock-short"><p>Specification of communication semantics on a socket.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="socket2"></div>
|
||||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user