deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions

1
socket2/all.html Normal file
View file

@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../socket2/index.html">socket2</a><span class="version">0.5.8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.Domain.html">Domain</a></li><li><a href="struct.MaybeUninitSlice.html">MaybeUninitSlice</a></li><li><a href="struct.MsgHdr.html">MsgHdr</a></li><li><a href="struct.MsgHdrMut.html">MsgHdrMut</a></li><li><a href="struct.Protocol.html">Protocol</a></li><li><a href="struct.RecvFlags.html">RecvFlags</a></li><li><a href="struct.SockAddr.html">SockAddr</a></li><li><a href="struct.SockRef.html">SockRef</a></li><li><a href="struct.Socket.html">Socket</a></li><li><a href="struct.TcpKeepalive.html">TcpKeepalive</a></li><li><a href="struct.Type.html">Type</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="enum.InterfaceIndexOrAddress.html">InterfaceIndexOrAddress</a></li></ul></section></div></main></body></html>

File diff suppressed because one or more lines are too long

32
socket2/index.html Normal file
View file

@ -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 creating and using sockets."><title>socket2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../socket2/index.html">socket2</a><span class="version">0.5.8</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a><ul><li><a href="#features" title="Features">Features</a></li></ul></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>socket2</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/socket2/lib.rs.html#9-743">Source</a> </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 systems
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 dont 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.84.1/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 class="doc-anchor" href="#examples">§</a>Examples</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">&amp;</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 class="doc-anchor" href="#features">§</a>Features</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">Structs<a href="#structs" class="anchor">§</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">Maybe<wbr>Uninit<wbr>Slice</a></div><div class="desc docblock-short">A version of <a href="https://doc.rust-lang.org/1.84.1/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">MsgHdr<wbr>Mut</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">Recv<wbr>Flags</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">Sock<wbr>Addr</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 sockets 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">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.InterfaceIndexOrAddress.html" title="enum socket2::InterfaceIndexOrAddress">Interface<wbr>Index<wbr>OrAddress</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>

1
socket2/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["InterfaceIndexOrAddress"],"struct":["Domain","MaybeUninitSlice","MsgHdr","MsgHdrMut","Protocol","RecvFlags","SockAddr","SockRef","Socket","TcpKeepalive","Type"]};

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../socket2/struct.SockAddr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../socket2/struct.SockAddr.html">../../socket2/struct.SockAddr.html</a>...</p>
<script>location.replace("../../socket2/struct.SockAddr.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../socket2/enum.InterfaceIndexOrAddress.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../socket2/enum.InterfaceIndexOrAddress.html">../../socket2/enum.InterfaceIndexOrAddress.html</a>...</p>
<script>location.replace("../../socket2/enum.InterfaceIndexOrAddress.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../socket2/struct.Socket.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../socket2/struct.Socket.html">../../socket2/struct.Socket.html</a>...</p>
<script>location.replace("../../socket2/struct.Socket.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../socket2/struct.SockRef.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../socket2/struct.SockRef.html">../../socket2/struct.SockRef.html</a>...</p>
<script>location.replace("../../socket2/struct.SockRef.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

995
socket2/struct.SockRef.html Normal file

File diff suppressed because one or more lines are too long

1100
socket2/struct.Socket.html Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

32
socket2/struct.Type.html Normal file

File diff suppressed because one or more lines are too long