blob: 7db3885ed85e52da1c739b12eba2289ca0815c16 [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 `MQTTClient_persistence` struct in crate `paho_mqtt3as_sys`.">
<meta name="keywords" content="rust, rustlang, rust-lang, MQTTClient_persistence">
<title>paho_mqtt3as_sys::MQTTClient_persistence - 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 MQTTClient_persistence</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: 'MQTTClient_persistence', 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=''>MQTTClient_persistence</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#1149-1168' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[repr(C)]
</div>pub struct MQTTClient_persistence {
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 popen: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_open.html" title="type paho_mqtt3as_sys::Persistence_open">Persistence_open</a>,
pub pclose: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_close.html" title="type paho_mqtt3as_sys::Persistence_close">Persistence_close</a>,
pub pput: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_put.html" title="type paho_mqtt3as_sys::Persistence_put">Persistence_put</a>,
pub pget: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_get.html" title="type paho_mqtt3as_sys::Persistence_get">Persistence_get</a>,
pub premove: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_remove.html" title="type paho_mqtt3as_sys::Persistence_remove">Persistence_remove</a>,
pub pkeys: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_keys.html" title="type paho_mqtt3as_sys::Persistence_keys">Persistence_keys</a>,
pub pclear: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_clear.html" title="type paho_mqtt3as_sys::Persistence_clear">Persistence_clear</a>,
pub pcontainskey: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_containskey.html" title="type paho_mqtt3as_sys::Persistence_containskey">Persistence_containskey</a>,
}</pre><div class='docblock'><p>@brief A structure containing the function pointers to a persistence
implementation and the context or state that will be shared across all
the persistence functions.</p>
</div><h2 id='fields' class='fields'>Fields</h2><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 data required to initialize the persistent store.</p>
</div><span id='structfield.popen' class="structfield">
<span id='popen.v' class='invisible'>
<code>popen: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_open.html" title="type paho_mqtt3as_sys::Persistence_open">Persistence_open</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_open().</p>
</div><span id='structfield.pclose' class="structfield">
<span id='pclose.v' class='invisible'>
<code>pclose: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_close.html" title="type paho_mqtt3as_sys::Persistence_close">Persistence_close</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_close().</p>
</div><span id='structfield.pput' class="structfield">
<span id='pput.v' class='invisible'>
<code>pput: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_put.html" title="type paho_mqtt3as_sys::Persistence_put">Persistence_put</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_put().</p>
</div><span id='structfield.pget' class="structfield">
<span id='pget.v' class='invisible'>
<code>pget: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_get.html" title="type paho_mqtt3as_sys::Persistence_get">Persistence_get</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_get().</p>
</div><span id='structfield.premove' class="structfield">
<span id='premove.v' class='invisible'>
<code>premove: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_remove.html" title="type paho_mqtt3as_sys::Persistence_remove">Persistence_remove</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_remove().</p>
</div><span id='structfield.pkeys' class="structfield">
<span id='pkeys.v' class='invisible'>
<code>pkeys: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_keys.html" title="type paho_mqtt3as_sys::Persistence_keys">Persistence_keys</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_keys().</p>
</div><span id='structfield.pclear' class="structfield">
<span id='pclear.v' class='invisible'>
<code>pclear: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_clear.html" title="type paho_mqtt3as_sys::Persistence_clear">Persistence_clear</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_clear().</p>
</div><span id='structfield.pcontainskey' class="structfield">
<span id='pcontainskey.v' class='invisible'>
<code>pcontainskey: <a class="type" href="../paho_mqtt3as_sys/type.Persistence_containskey.html" title="type paho_mqtt3as_sys::Persistence_containskey">Persistence_containskey</a></code>
</span></span><div class='docblock'><p>A function pointer to an implementation of Persistence_containskey().</p>
</div><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.MQTTClient_persistence.html" title="struct paho_mqtt3as_sys::MQTTClient_persistence">MQTTClient_persistence</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#1148' 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.MQTTClient_persistence.html" title="struct paho_mqtt3as_sys::MQTTClient_persistence">MQTTClient_persistence</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#1148' 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.MQTTClient_persistence.html" title="struct paho_mqtt3as_sys::MQTTClient_persistence">MQTTClient_persistence</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#1223-1225' 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></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>