blob: 11f43eb3fda2b54d2e35cc000503375089358391 [file] [log] [blame]
<!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 `DisconnectOptionsBuilder` struct in crate `paho_mqtt`.">
<meta name="keywords" content="rust, rustlang, rust-lang, DisconnectOptionsBuilder">
<title>paho_mqtt::disconnect_options::DisconnectOptionsBuilder - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
<p class='location'>Struct DisconnectOptionsBuilder</p><div class="block items"><ul><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='../index.html'>paho_mqtt</a>::<wbr><a href='index.html'>disconnect_options</a></p><script>window.sidebarCurrent = {name: 'DisconnectOptionsBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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'>paho_mqtt</a>::<wbr><a href='index.html'>disconnect_options</a>::<wbr><a class="struct" href=''>DisconnectOptionsBuilder</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/paho_mqtt/disconnect_options.rs.html#48-50' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct DisconnectOptionsBuilder { /* fields omitted */ }</pre><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../paho_mqtt/disconnect_options/struct.DisconnectOptionsBuilder.html" title="struct paho_mqtt::disconnect_options::DisconnectOptionsBuilder">DisconnectOptionsBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/disconnect_options.rs.html#52-78' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../paho_mqtt/disconnect_options/struct.DisconnectOptionsBuilder.html" title="struct paho_mqtt::disconnect_options::DisconnectOptionsBuilder">DisconnectOptionsBuilder</a></code></span></h4>
<h4 id='method.timeout' class="method"><span id='timeout.v' class='invisible'><code>fn <a href='#method.timeout' class='fnname'>timeout</a>(&amp;mut self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/duration/struct.Duration.html" title="struct std::time::duration::Duration">Duration</a>) -&gt; &amp;mut <a class="struct" href="../../paho_mqtt/disconnect_options/struct.DisconnectOptionsBuilder.html" title="struct paho_mqtt::disconnect_options::DisconnectOptionsBuilder">DisconnectOptionsBuilder</a></code></span></h4>
<div class='docblock'><p>Sets the time interval to allow the disconnect to complete.
This specifies the time to allow in-flight messages to complete.</p>
<h1 id='arguments' class='section-header'><a href='#arguments'>Arguments</a></h1>
<p><code>timeout</code> The time interval to allow the disconnect to
complete. This has a resolution of seconds.</p>
</div><h4 id='method.finalize' class="method"><span id='finalize.v' class='invisible'><code>fn <a href='#method.finalize' class='fnname'>finalize</a>(&amp;self) -&gt; <a class="struct" href="../../paho_mqtt/disconnect_options/struct.DisconnectOptions.html" title="struct paho_mqtt::disconnect_options::DisconnectOptions">DisconnectOptions</a></code></span></h4>
<div class='docblock'><p>Finalize the builder to create the connect options.</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "paho_mqtt";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>