183 lines
No EOL
20 KiB
HTML
183 lines
No EOL
20 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="API documentation for the Rust `UdpBuilder` struct in crate `net2`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, UdpBuilder">
|
||
|
||
<title>net2::UdpBuilder - 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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[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='../net2/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
|
||
<p class='location'>Struct UdpBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new_v4">new_v4</a><a href="#method.new_v6">new_v6</a><a href="#method.bind">bind</a><a href="#method.ttl">ttl</a><a href="#method.only_v6">only_v6</a><a href="#method.reuse_address">reuse_address</a><a href="#method.get_reuse_address">get_reuse_address</a><a href="#method.take_error">take_error</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-FromRawFd">FromRawFd</a><a href="#impl-AsRawFd">AsRawFd</a><a href="#impl-UnixUdpBuilderExt">UnixUdpBuilderExt</a></div></div><p class='location'><a href='index.html'>net2</a></p><script>window.sidebarCurrent = {name: 'UdpBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>net2</a>::<wbr><a class="struct" href=''>UdpBuilder</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/net2/udp.rs.html#23-25' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct UdpBuilder { /* fields omitted */ }</pre><div class='docblock'><p>An "in progress" UDP socket which has not yet been connected.</p>
|
||
<p>Allows configuration of a socket before the socket is connected.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#27-69' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new_v4' class="method"><span id='new_v4.v' class='invisible'><code>pub fn <a href='#method.new_v4' class='fnname'>new_v4</a>() -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#33-35' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Constructs a new UdpBuilder with the <code>AF_INET</code> domain, the <code>SOCK_DGRAM</code>
|
||
type, and with a protocol argument of 0.</p>
|
||
<p>Note that passing other kinds of flags or arguments can be done through
|
||
the <code>FromRaw{Fd,Socket}</code> implementation.</p>
|
||
</div><h4 id='method.new_v6' class="method"><span id='new_v6.v' class='invisible'><code>pub fn <a href='#method.new_v6' class='fnname'>new_v6</a>() -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#42-44' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Constructs a new UdpBuilder with the <code>AF_INET6</code> domain, the <code>SOCK_DGRAM</code>
|
||
type, and with a protocol argument of 0.</p>
|
||
<p>Note that passing other kinds of flags or arguments can be done through
|
||
the <code>FromRaw{Fd,Socket}</code> implementation.</p>
|
||
</div><h4 id='method.bind' class="method"><span id='bind.v' class='invisible'><code>pub fn <a href='#method.bind' class='fnname'>bind</a><T>(&self, addr: T) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#50-58' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Binds this socket to the specified address.</p>
|
||
<p>This function directly corresponds to the bind(2) function on Windows
|
||
and Unix.</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1457-1501' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.ttl' class="method"><span id='ttl.v' class='invisible'><code>pub fn <a href='#method.ttl' class='fnname'>ttl</a>(&self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1463-1466' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Sets the value for the <code>IP_TTL</code> option on this socket.</p>
|
||
<p>This is the same as <a href="trait.TcpStreamExt.html#tymethod.set_ttl"><code>TcpStreamExt::set_ttl</code></a>.</p>
|
||
</div><h4 id='method.only_v6' class="method"><span id='only_v6.v' class='invisible'><code>pub fn <a href='#method.only_v6' class='fnname'>only_v6</a>(&self, only_v6: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1473-1476' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Sets the value for the <code>IPV6_V6ONLY</code> option on this socket.</p>
|
||
<p>This is the same as <a href="struct.TcpBuilder.html#method.only_v6"><code>TcpStream::only_v6</code></a>.</p>
|
||
</div><h4 id='method.reuse_address' class="method"><span id='reuse_address.v' class='invisible'><code>pub fn <a href='#method.reuse_address' class='fnname'>reuse_address</a>(&self, reuse: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1483-1486' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Set value for the <code>SO_REUSEADDR</code> option on this socket.</p>
|
||
<p>This is the same as <a href="struct.TcpBuilder.html#method.reuse_address"><code>TcpBuilder::reuse_address</code></a>.</p>
|
||
</div><h4 id='method.get_reuse_address' class="method"><span id='get_reuse_address.v' class='invisible'><code>pub fn <a href='#method.get_reuse_address' class='fnname'>get_reuse_address</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1489-1491' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Check the <code>SO_REUSEADDR</code> option on this socket.</p>
|
||
</div><h4 id='method.take_error' class="method"><span id='take_error.v' class='invisible'><code>pub fn <a href='#method.take_error' class='fnname'>take_error</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/ext.rs.html#1498-1500' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Get the value of the <code>SO_ERROR</code> option on this socket.</p>
|
||
<p>This will retrieve the stored error in the underlying socket, clearing
|
||
the field in the process. This can be useful for checking errors between
|
||
calls.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#71-76' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/udp.rs.html#72-75' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-FromRawFd' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html" title="trait std::sys::unix::ext::io::FromRawFd">FromRawFd</a> for <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl-FromRawFd' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/sys/unix/impls.rs.html#32-37' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from_raw_fd' class="method"><span id='from_raw_fd.v' class='invisible'><code>unsafe fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html#tymethod.from_raw_fd' class='fnname'>from_raw_fd</a>(fd: <a class="type" href="../libc/type.c_int.html" title="type libc::c_int">c_int</a>) -> <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/sys/unix/impls.rs.html#33-36' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Constructs a new instance of <code>Self</code> from the given raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html#tymethod.from_raw_fd">Read more</a></p>
|
||
</div></div><h3 id='impl-AsRawFd' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html" title="trait std::sys::unix::ext::io::AsRawFd">AsRawFd</a> for <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl-AsRawFd' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/sys/unix/impls.rs.html#39-44' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.as_raw_fd' class="method"><span id='as_raw_fd.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd' class='fnname'>as_raw_fd</a>(&self) -> <a class="type" href="../libc/type.c_int.html" title="type libc::c_int">c_int</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/sys/unix/impls.rs.html#40-43' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></p>
|
||
</div></div><h3 id='impl-UnixUdpBuilderExt' class='impl'><span class='in-band'><code>impl <a class="trait" href="../net2/unix/trait.UnixUdpBuilderExt.html" title="trait net2::unix::UnixUdpBuilderExt">UnixUdpBuilderExt</a> for <a class="struct" href="../net2/struct.UdpBuilder.html" title="struct net2::UdpBuilder">UdpBuilder</a></code><a href='#impl-UnixUdpBuilderExt' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/unix.rs.html#47-57' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.reuse_port' class="method"><span id='reuse_port.v' class='invisible'><code>fn <a href='../net2/unix/trait.UnixUdpBuilderExt.html#tymethod.reuse_port' class='fnname'>reuse_port</a>(&self, reuse: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/unix.rs.html#48-51' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Set value for the <code>SO_REUSEPORT</code> option on this socket. <a href="../net2/unix/trait.UnixUdpBuilderExt.html#tymethod.reuse_port">Read more</a></p>
|
||
</div><h4 id='method.get_reuse_port' class="method"><span id='get_reuse_port.v' class='invisible'><code>fn <a href='../net2/unix/trait.UnixUdpBuilderExt.html#tymethod.get_reuse_port' class='fnname'>get_reuse_port</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/net2/unix.rs.html#53-56' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Check the value of the <code>SO_REUSEPORT</code> option on this socket.</p>
|
||
</div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "net2";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |