blob: a33308a3eb8f82eb030db8358b3e5dcd29845258 [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 `MQTTAsync_connectOptions` struct in crate `paho_mqtt3as_sys`.">
<meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_connectOptions">
<title>paho_mqtt3as_sys::MQTTAsync_connectOptions - 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 MQTTAsync_connectOptions</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>paho_mqtt3as_sys</a></p><script>window.sidebarCurrent = {name: 'MQTTAsync_connectOptions', 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_mqtt3as_sys</a>::<wbr><a class="struct" href=''>MQTTAsync_connectOptions</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_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#2141-2235' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[repr(C)]
</div>pub struct MQTTAsync_connectOptions {
pub struct_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a>,
pub struct_version: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub keepAliveInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub cleansession: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub maxInflight: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub will: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_willOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_willOptions">MQTTAsync_willOptions</a>,
pub username: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>,
pub password: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>,
pub connectTimeout: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub retryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub ssl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_SSLOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_SSLOptions">MQTTAsync_SSLOptions</a>,
pub onSuccess: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_onSuccess.html" title="type paho_mqtt3as_sys::MQTTAsync_onSuccess">MQTTAsync_onSuccess</a>,
pub onFailure: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_onFailure.html" title="type paho_mqtt3as_sys::MQTTAsync_onFailure">MQTTAsync_onFailure</a>,
pub context: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title="enum std::os::raw::c_void">c_void</a>,
pub serverURIcount: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub serverURIs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>,
pub MQTTVersion: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub automaticReconnect: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub minRetryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub maxRetryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>,
pub binarypwd: <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions__bindgen_ty_1.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions__bindgen_ty_1">MQTTAsync_connectOptions__bindgen_ty_1</a>,
}</pre><div class='docblock'><p>MQTTAsync_connectOptions defines several settings that control the way the
client connects to an MQTT server. Default values are set in
MQTTAsync_connectOptions_initializer.</p>
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.struct_id' class="structfield">
<span id='struct_id.v' class='invisible'>
<code>struct_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a></code>
</span></span><div class='docblock'><p>The eyecatcher for this structure. must be MQTC.</p>
</div><span id='structfield.struct_version' class="structfield">
<span id='struct_version.v' class='invisible'>
<code>struct_version: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>The version number of this structure. Must be 0, 1, 2, 3 4 or 5.
0 signifies no SSL options and no serverURIs
1 signifies no serverURIs
2 signifies no MQTTVersion
3 signifies no automatic reconnect options
4 signifies no binary password option (just string)</p>
</div><span id='structfield.keepAliveInterval' class="structfield">
<span id='keepAliveInterval.v' class='invisible'>
<code>keepAliveInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>The &quot;keep alive&quot; interval, measured in seconds, defines the maximum time
that should pass without communication between the client and the server
The client will ensure that at least one message travels across the
network within each keep alive period. In the absence of a data-related
message during the time period, the client sends a very small MQTT
&quot;ping&quot; message, which the server will acknowledge. The keep alive
interval enables the client to detect when the server is no longer
available without having to wait for the long TCP/IP timeout.
Set to 0 if you do not want any keep alive processing.</p>
</div><span id='structfield.cleansession' class="structfield">
<span id='cleansession.v' class='invisible'>
<code>cleansession: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>This is a boolean value. The cleansession setting controls the behaviour
of both the client and the server at connection and disconnection time.
The client and server both maintain session state information. This
information is used to ensure &quot;at least once&quot; and &quot;exactly once&quot;
delivery, and &quot;exactly once&quot; receipt of messages. Session state also
includes subscriptions created by an MQTT client. You can choose to
maintain or discard state information between sessions.</p>
<p>When cleansession is true, the state information is discarded at
connect and disconnect. Setting cleansession to false keeps the state
information. When you connect an MQTT client application with
MQTTAsync_connect(), the client identifies the connection using the
client identifier and the address of the server. The server checks
whether session information for this client
has been saved from a previous connection to the server. If a previous
session still exists, and cleansession=true, then the previous session
information at the client and server is cleared. If cleansession=false,
the previous session is resumed. If no previous session exists, a new
session is started.</p>
</div><span id='structfield.maxInflight' class="structfield">
<span id='maxInflight.v' class='invisible'>
<code>maxInflight: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>This controls how many messages can be in-flight simultaneously.</p>
</div><span id='structfield.will' class="structfield">
<span id='will.v' class='invisible'>
<code>will: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_willOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_willOptions">MQTTAsync_willOptions</a></code>
</span></span><div class='docblock'><p>This is a pointer to an MQTTAsync_willOptions structure. If your
application does not make use of the Last Will and Testament feature,
set this pointer to NULL.</p>
</div><span id='structfield.username' class="structfield">
<span id='username.v' class='invisible'>
<code>username: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a></code>
</span></span><div class='docblock'><p>MQTT servers that support the MQTT v3.1 protocol provide authentication
and authorisation by user name and password. This is the user name
parameter.</p>
</div><span id='structfield.password' class="structfield">
<span id='password.v' class='invisible'>
<code>password: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a></code>
</span></span><div class='docblock'><p>MQTT servers that support the MQTT v3.1 protocol provide authentication
and authorisation by user name and password. This is the password
parameter.</p>
</div><span id='structfield.connectTimeout' class="structfield">
<span id='connectTimeout.v' class='invisible'>
<code>connectTimeout: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>The time interval in seconds to allow a connect to complete.</p>
</div><span id='structfield.retryInterval' class="structfield">
<span id='retryInterval.v' class='invisible'>
<code>retryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>The time interval in seconds</p>
</div><span id='structfield.ssl' class="structfield">
<span id='ssl.v' class='invisible'>
<code>ssl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_SSLOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_SSLOptions">MQTTAsync_SSLOptions</a></code>
</span></span><div class='docblock'><p>This is a pointer to an MQTTAsync_SSLOptions structure. If your
application does not make use of SSL, set this pointer to NULL.</p>
</div><span id='structfield.onSuccess' class="structfield">
<span id='onSuccess.v' class='invisible'>
<code>onSuccess: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_onSuccess.html" title="type paho_mqtt3as_sys::MQTTAsync_onSuccess">MQTTAsync_onSuccess</a></code>
</span></span><div class='docblock'><p>A pointer to a callback function to be called if the connect successfully
completes. Can be set to NULL, in which case no indication of successful
completion will be received.</p>
</div><span id='structfield.onFailure' class="structfield">
<span id='onFailure.v' class='invisible'>
<code>onFailure: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_onFailure.html" title="type paho_mqtt3as_sys::MQTTAsync_onFailure">MQTTAsync_onFailure</a></code>
</span></span><div class='docblock'><p>A pointer to a callback function to be called if the connect fails.
Can be set to NULL, in which case no indication of unsuccessful
completion will be received.</p>
</div><span id='structfield.context' class="structfield">
<span id='context.v' class='invisible'>
<code>context: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title="enum std::os::raw::c_void">c_void</a></code>
</span></span><div class='docblock'><p>A pointer to any application-specific context. The
the <i>context</i> pointer is passed to success or failure callback functions to
provide access to the context information in the callback.</p>
</div><span id='structfield.serverURIcount' class="structfield">
<span id='serverURIcount.v' class='invisible'>
<code>serverURIcount: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>The number of entries in the serverURIs array.</p>
</div><span id='structfield.serverURIs' class="structfield">
<span id='serverURIs.v' class='invisible'>
<code>serverURIs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a></code>
</span></span><div class='docblock'><p>An array of null-terminated strings specifying the servers to
which the client will connect. Each string takes the form <i>protocol://host:port</i>.
<i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
specify either an IP address or a domain name. For instance, to connect to
a server running on the local machines with the default MQTT port, specify
<i>tcp://localhost:1883</i>.</p>
</div><span id='structfield.MQTTVersion' class="structfield">
<span id='MQTTVersion.v' class='invisible'>
<code>MQTTVersion: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>Sets the version of MQTT to be used on the connect.
MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1
MQTTVERSION_3_1 (3) = only try version 3.1
MQTTVERSION_3_1_1 (4) = only try version 3.1.1</p>
</div><span id='structfield.automaticReconnect' class="structfield">
<span id='automaticReconnect.v' class='invisible'>
<code>automaticReconnect: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>Reconnect automatically in the case of a connection being lost?</p>
</div><span id='structfield.minRetryInterval' class="structfield">
<span id='minRetryInterval.v' class='invisible'>
<code>minRetryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>Minimum retry interval in seconds. Doubled on each failed retry.</p>
</div><span id='structfield.maxRetryInterval' class="structfield">
<span id='maxRetryInterval.v' class='invisible'>
<code>maxRetryInterval: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code>
</span></span><div class='docblock'><p>Maximum retry interval in seconds. The doubling stops here on failed retries.</p>
</div><span id='structfield.binarypwd' class="structfield">
<span id='binarypwd.v' class='invisible'>
<code>binarypwd: <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions__bindgen_ty_1.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions__bindgen_ty_1">MQTTAsync_connectOptions__bindgen_ty_1</a></code>
</span></span><h2 id='implementations'>Trait Implementations</h2><h3 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="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/paho_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#2140' 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>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/paho_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#2140' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/paho_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#2408-2410' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; Self</code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/paho_mqtt3as_sys/lib.rs.html#34-63' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</a></code></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></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_mqtt3as_sys";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>