47 lines
10 KiB
HTML
47 lines
10 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="Utilities for creating and using sockets."><meta name="keywords" content="rust, rustlang, rust-lang, socket2"><title>socket2 - 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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.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 crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../socket2/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate socket2</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.4.4</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><li><a href="#enums">Enums</a></li></ul></div><div id="sidebar-vars" data-name="socket2" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../socket2/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">socket2</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></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#9-442" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Utilities for creating and using sockets.</p>
|
||
<p>The goal of this crate is to create and use a socket using advanced
|
||
configuration options (those that are not available in the types in the
|
||
standard library) without using any unsafe code.</p>
|
||
<p>This crate provides as direct as possible access to the system’s
|
||
functionality for sockets, this means little effort to provide
|
||
cross-platform utilities. It is up to the user to know how to use sockets
|
||
when using this crate. <em>If you don’t know how to create a socket using
|
||
libc/system calls then this crate is not for you</em>. Most, if not all,
|
||
functions directly relate to the equivalent system call with no error
|
||
handling applied, so no handling errors such as <a href="https://doc.rust-lang.org/1.59.0/std/io/error/enum.ErrorKind.html#variant.Interrupted"><code>EINTR</code></a>. As a result using
|
||
this crate can be a little wordy, but it should give you maximal flexibility
|
||
over configuration of sockets.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::net</span>::{<span class="ident">SocketAddr</span>, <span class="ident">TcpListener</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::new</span>(<span class="ident">Domain::IPV6</span>, <span class="ident">Type::STREAM</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="ident">socket</span>.<span class="ident">set_only_v6</span>(<span class="bool-val">false</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">address</span>: <span class="ident">SocketAddr</span> <span class="op">=</span> <span class="string">"[::1]:12345"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="ident">socket</span>.<span class="ident">bind</span>(<span class="kw-2">&</span><span class="ident">address</span>.<span class="ident">into</span>())<span class="question-mark">?</span>;
|
||
<span class="ident">socket</span>.<span class="ident">listen</span>(<span class="number">128</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">listener</span>: <span class="ident">TcpListener</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">into</span>();
|
||
<span class="comment">// ...</span></code></pre></div>
|
||
<h3 id="features" class="section-header"><a href="#features">Features</a></h3>
|
||
<p>This crate has a single feature <code>all</code>, which enables all functions even ones
|
||
that are not available on all OSs.</p>
|
||
</div></details><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.Domain.html" title="socket2::Domain struct">Domain</a></div><div class="item-right docblock-short"><p>Specification of the communication domain for a socket.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MaybeUninitSlice.html" title="socket2::MaybeUninitSlice struct">MaybeUninitSlice</a></div><div class="item-right docblock-short"><p>A version of <a href="https://doc.rust-lang.org/1.59.0/std/io/struct.IoSliceMut.html"><code>IoSliceMut</code></a> that allows the buffer to be uninitialised.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Protocol.html" title="socket2::Protocol struct">Protocol</a></div><div class="item-right docblock-short"><p>Protocol specification used for creating sockets via <code>Socket::new</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RecvFlags.html" title="socket2::RecvFlags struct">RecvFlags</a></div><div class="item-right docblock-short"><p>Flags for incoming messages.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SockAddr.html" title="socket2::SockAddr struct">SockAddr</a></div><div class="item-right docblock-short"><p>The address of a socket.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SockRef.html" title="socket2::SockRef struct">SockRef</a></div><div class="item-right docblock-short"><p>A reference to a <a href="struct.Socket.html" title="Socket"><code>Socket</code></a> that can be used to configure socket types other
|
||
than the <code>Socket</code> type itself.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Socket.html" title="socket2::Socket struct">Socket</a></div><div class="item-right docblock-short"><p>Owned wrapper around a system socket.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TcpKeepalive.html" title="socket2::TcpKeepalive struct">TcpKeepalive</a></div><div class="item-right docblock-short"><p>Configures a socket’s TCP keepalive parameters.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Type.html" title="socket2::Type struct">Type</a></div><div class="item-right docblock-short"><p>Specification of communication semantics on a socket.</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.InterfaceIndexOrAddress.html" title="socket2::InterfaceIndexOrAddress enum">InterfaceIndexOrAddress</a></div><div class="item-right docblock-short"><p>A local interface specified by its index or an address assigned to it.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="socket2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |