|
|
<!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 `TcpListenerExt` trait in crate `net2`."><meta name="keywords" content="rust, rustlang, rust-lang, TcpListenerExt"><title>net2::TcpListenerExt - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo'></div></a><p class='location'>Trait TcpListenerExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.linger">linger</a><a href="#tymethod.only_v6">only_v6</a><a href="#tymethod.set_linger">set_linger</a><a href="#tymethod.set_nonblocking">set_nonblocking</a><a href="#tymethod.set_only_v6">set_only_v6</a><a href="#tymethod.set_ttl">set_ttl</a><a href="#tymethod.take_error">take_error</a><a href="#tymethod.ttl">ttl</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-TcpListenerExt-for-TcpListener">TcpListener</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>net2</a></p><script>window.sidebarCurrent = {name: 'TcpListenerExt', ty: 'trait', 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"><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><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='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/ext.rs.html#300-352' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>net2</a>::<wbr><a class="trait" href=''>TcpListenerExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait TcpListenerExt {
|
|
|
fn <a href='#tymethod.set_ttl' class='fnname'>set_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.unit.html">()</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.ttl' class='fnname'>ttl</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.u32.html">u32</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_only_v6' class='fnname'>set_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.unit.html">()</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.only_v6' class='fnname'>only_v6</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>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.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>>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_nonblocking' class='fnname'>set_nonblocking</a>(&self, nonblocking: <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.unit.html">()</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_linger' class='fnname'>set_linger</a>(&self, dur: <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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</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.unit.html">()</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.linger' class='fnname'>linger</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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>>>;
|
|
|
}</pre></div><div class='docblock'><p>Extension methods for the standard <a href="https://doc.rust-lang.org/std/net/struct.TcpListener.html"><code>TcpListener</code> type</a> in <code>std::net</code>.</p>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.set_ttl' class='method'><code id='set_ttl.v'>fn <a href='#tymethod.set_ttl' class='fnname'>set_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.unit.html">()</a>></code></h3><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><h3 id='tymethod.ttl' class='method'><code id='ttl.v'>fn <a href='#tymethod.ttl' class='fnname'>ttl</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.u32.html">u32</a>></code></h3><div class='docblock'><p>Gets the value of the <code>IP_TTL</code> option for this socket.</p>
|
|
|
<p>For more information about this option, see
|
|
|
<a href="trait.TcpStreamExt.html#tymethod.set_ttl"><code>TcpStreamExt::set_ttl</code></a>.</p>
|
|
|
</div><h3 id='tymethod.set_only_v6' class='method'><code id='set_only_v6.v'>fn <a href='#tymethod.set_only_v6' class='fnname'>set_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.unit.html">()</a>></code></h3><div class='docblock'><p>Sets the value for the <code>IPV6_V6ONLY</code> option on this socket.</p>
|
|
|
<p>For more information about this option, see
|
|
|
<a href="trait.TcpStreamExt.html#tymethod.set_only_v6"><code>TcpStreamExt::set_only_v6</code></a>.</p>
|
|
|
</div><h3 id='tymethod.only_v6' class='method'><code id='only_v6.v'>fn <a href='#tymethod.only_v6' class='fnname'>only_v6</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></h3><div class='docblock'><p>Gets the value of the <code>IPV6_V6ONLY</code> option for this socket.</p>
|
|
|
<p>For more information about this option, see
|
|
|
<a href="trait.TcpStreamExt.html#tymethod.set_only_v6"><code>TcpStreamExt::set_only_v6</code></a>.</p>
|
|
|
</div><h3 id='tymethod.take_error' class='method'><code id='take_error.v'>fn <a href='#tymethod.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></h3><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><h3 id='tymethod.set_nonblocking' class='method'><code id='set_nonblocking.v'>fn <a href='#tymethod.set_nonblocking' class='fnname'>set_nonblocking</a>(&self, nonblocking: <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.unit.html">()</a>></code></h3><div class='docblock'><p>Moves this TCP listener into or out of nonblocking mode.</p>
|
|
|
<p>For more information about this option, see
|
|
|
<a href="trait.TcpStreamExt.html#tymethod.set_nonblocking"><code>TcpStreamExt::set_nonblocking</code></a>.</p>
|
|
|
</div><h3 id='tymethod.set_linger' class='method'><code id='set_linger.v'>fn <a href='#tymethod.set_linger' class='fnname'>set_linger</a>(&self, dur: <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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</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.unit.html">()</a>></code></h3><div class='docblock'><p>Sets the linger duration of this socket by setting the SO_LINGER option</p>
|
|
|
</div><h3 id='tymethod.linger' class='method'><code id='linger.v'>fn <a href='#tymethod.linger' class='fnname'>linger</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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>>></code></h3><div class='docblock'><p>reads the linger duration for this socket by getting the SO_LINGER option</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-TcpListenerExt-for-TcpListener' class='impl'><code class='in-band'>impl <a class="trait" href="../net2/trait.TcpListenerExt.html" title="trait net2::TcpListenerExt">TcpListenerExt</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/tcp/struct.TcpListener.html" title="struct std::net::tcp::TcpListener">TcpListener</a></code><a href='#impl-TcpListenerExt-for-TcpListener' class='anchor'></a><a class='srclink' href='../src/net2/ext.rs.html#1366-1399' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.set_ttl' class="method hidden"><code id='set_ttl.v-1'>fn <a href='#method.set_ttl' class='fnname'>set_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.unit.html">()</a>></code><a class='srclink' href='../src/net2/ext.rs.html#1367-1369' title='goto source code'>[src]</a></h4><h4 id='method.ttl' class="method hidden"><code id='ttl.v-1'>fn <a href='#method.ttl' class='fnname'>ttl</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.u32.html">u32</a>></code><a class='srclink' href='../src/net2/ext.rs.html#1371-1374' title='goto source code'>[src]</a></h4><h4 id='method.set_only_v6' class="method hidden"><code id='set_only_v6.v-1'>fn <a href='#method.set_only_v6' class='fnname'>set_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.unit.html">()</a>></code><a class='srclink' href='../src/net2/ext.rs.html#1376-1378' title='goto source code'>[src]</a></h4><h4 id='method.only_v6' class="method hidden"><code id='only_v6.v-1'>fn <a href='#method.only_v6' class='fnname'>only_v6</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><a class='srclink' href='../src/net2/ext.rs.html#1380-1382' title='goto source code'>[src]</a></h4><h4 id='method.take_error' class="method hidden"><code id='take_error.v-1'>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><a class='srclink' href='../src/net2/ext.rs.html#1384-1386' title='goto source code'>[src]</a></h4><h4 id='method.set_nonblocking' class="method hidden"><code id='set_nonblocking.v-1'>fn <a href='#method.set_nonblocking' class='fnname'>set_nonblocking</a>(&self, nonblocking: <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.unit.html">()</a>></code><a class='srclink' href='../src/net2/ext.rs.html#1388-1390' title='goto source code'>[src]</a></h4><h4 id='method.set_linger' class="method hidden"><code id='set_linger.v-1'>fn <a href='#method.set_linger' class='fnname'>set_linger</a>(&self, dur: <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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</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.unit.html">()</a>></code><a class='srclink' href='../src/net2/ext.rs.html#1392-1394' title='goto source code'>[src]</a></h4><h4 id='method.linger' class="method hidden"><code id='linger.v-1'>fn <a href='#method.linger' class='fnname'>linger</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/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>>></code><a class='srclink' href='../src/net2/ext.rs.html#1396-1398' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
src="../implementors/net2/trait.TcpListenerExt.js">
|
|
|
</script></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "net2";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
