mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
34 lines
9.1 KiB
HTML
34 lines
9.1 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."><title>socket2 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="socket2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../socket2/index.html">socket2</a><span class="version">0.5.5</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../socket2/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">socket2</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/socket2/lib.rs.html#9-722">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="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.76.0/std/io/error/enum.ErrorKind.html#variant.Interrupted" title="variant std::io::error::ErrorKind::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"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::net::{SocketAddr, TcpListener};
|
||
<span class="kw">use </span>socket2::{Socket, Domain, Type};
|
||
|
||
<span class="comment">// Create a TCP listener bound to two addresses.
|
||
</span><span class="kw">let </span>socket = Socket::new(Domain::IPV6, Type::STREAM, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
|
||
|
||
socket.set_only_v6(<span class="bool-val">false</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let </span>address: SocketAddr = <span class="string">"[::1]:12345"</span>.parse().unwrap();
|
||
socket.bind(<span class="kw-2">&</span>address.into())<span class="question-mark">?</span>;
|
||
socket.listen(<span class="number">128</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let </span>listener: TcpListener = socket.into();
|
||
<span class="comment">// ...</span></code></pre></div>
|
||
<h3 id="features"><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="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Domain.html" title="struct socket2::Domain">Domain</a></div><div class="desc docblock-short">Specification of the communication domain for a socket.</div></li><li><div class="item-name"><a class="struct" href="struct.MaybeUninitSlice.html" title="struct socket2::MaybeUninitSlice">MaybeUninitSlice</a></div><div class="desc docblock-short">A version of <a href="https://doc.rust-lang.org/1.76.0/std/io/struct.IoSliceMut.html" title="struct std::io::IoSliceMut"><code>IoSliceMut</code></a> that allows the buffer to be uninitialised.</div></li><li><div class="item-name"><a class="struct" href="struct.MsgHdr.html" title="struct socket2::MsgHdr">MsgHdr</a></div><div class="desc docblock-short">Configuration of a <code>sendmsg(2)</code> system call.</div></li><li><div class="item-name"><a class="struct" href="struct.MsgHdrMut.html" title="struct socket2::MsgHdrMut">MsgHdrMut</a></div><div class="desc docblock-short">Configuration of a <code>recvmsg(2)</code> system call.</div></li><li><div class="item-name"><a class="struct" href="struct.Protocol.html" title="struct socket2::Protocol">Protocol</a></div><div class="desc docblock-short">Protocol specification used for creating sockets via <code>Socket::new</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.RecvFlags.html" title="struct socket2::RecvFlags">RecvFlags</a></div><div class="desc docblock-short">Flags for incoming messages.</div></li><li><div class="item-name"><a class="struct" href="struct.SockAddr.html" title="struct socket2::SockAddr">SockAddr</a></div><div class="desc docblock-short">The address of a socket.</div></li><li><div class="item-name"><a class="struct" href="struct.SockRef.html" title="struct socket2::SockRef">SockRef</a></div><div class="desc docblock-short">A reference to a <a href="struct.Socket.html" title="struct socket2::Socket"><code>Socket</code></a> that can be used to configure socket types other
|
||
than the <code>Socket</code> type itself.</div></li><li><div class="item-name"><a class="struct" href="struct.Socket.html" title="struct socket2::Socket">Socket</a></div><div class="desc docblock-short">Owned wrapper around a system socket.</div></li><li><div class="item-name"><a class="struct" href="struct.TcpKeepalive.html" title="struct socket2::TcpKeepalive">TcpKeepalive</a></div><div class="desc docblock-short">Configures a socket’s TCP keepalive parameters.</div></li><li><div class="item-name"><a class="struct" href="struct.Type.html" title="struct socket2::Type">Type</a></div><div class="desc docblock-short">Specification of communication semantics on a socket.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.InterfaceIndexOrAddress.html" title="enum socket2::InterfaceIndexOrAddress">InterfaceIndexOrAddress</a></div><div class="desc docblock-short">A local interface specified by its index or an address assigned to it.</div></li></ul></section></div></main></body></html> |