| <!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 `ClientPersistence` trait in crate `paho_mqtt`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, ClientPersistence"> |
| |
| <title>paho_mqtt::client_persistence::ClientPersistence - 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 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"> |
| |
| <p class='location'>Trait ClientPersistence</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>paho_mqtt</a>::<wbr><a href='index.html'>client_persistence</a></p><script>window.sidebarCurrent = {name: 'ClientPersistence', ty: 'trait', 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'>Trait <a href='../index.html'>paho_mqtt</a>::<wbr><a href='index.html'>client_persistence</a>::<wbr><a class="trait" href=''>ClientPersistence</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/paho_mqtt/client_persistence.rs.html#40-82' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust trait'>pub trait ClientPersistence { |
| fn <a href='#tymethod.open' class='fnname'>open</a>(&mut self, client_id: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, server_uri: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.close' class='fnname'>close</a>(&mut self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.put' class='fnname'>put</a>(&mut self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, buffers: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.get' class='fnname'>get</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.remove' class='fnname'>remove</a>(&mut self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.keys' class='fnname'>keys</a>(&self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.clear' class='fnname'>clear</a>(&mut self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.contains_key' class='fnname'>contains_key</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| }</pre><div class='docblock'><p>Trait to implement custom persistence in the client.</p> |
| </div> |
| <h2 id='required-methods'>Required Methods</h2> |
| <div class='methods'> |
| <h3 id='tymethod.open' class='method'><span id='open.v' class='invisible'><code>fn <a href='#tymethod.open' class='fnname'>open</a>(&mut self, client_id: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, server_uri: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h3><div class='docblock'><p>Open and initialize the persistent store. |
| @param client_id The unique client identifier. |
| @param server_uri The address of the server to which the client is |
| connected. </p> |
| </div><h3 id='tymethod.close' class='method'><span id='close.v' class='invisible'><code>fn <a href='#tymethod.close' class='fnname'>close</a>(&mut self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h3><div class='docblock'><p>Close the persistence store.</p> |
| </div><h3 id='tymethod.put' class='method'><span id='put.v' class='invisible'><code>fn <a href='#tymethod.put' class='fnname'>put</a>(&mut self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, buffers: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h3><div class='docblock'><p>Put data into the persistence store. |
| @param key The key to the data. |
| @param The data to place into the store.</p> |
| </div><h3 id='tymethod.get' class='method'><span id='get.v' class='invisible'><code>fn <a href='#tymethod.get' class='fnname'>get</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>></code></span></h3><div class='docblock'><p>Gets data from the persistence store. |
| @param key They key for the desired data.</p> |
| </div><h3 id='tymethod.remove' class='method'><span id='remove.v' class='invisible'><code>fn <a href='#tymethod.remove' class='fnname'>remove</a>(&mut self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h3><div class='docblock'><p>Removes data for the specified key. |
| @param key The key for the data to remove.</p> |
| </div><h3 id='tymethod.keys' class='method'><span id='keys.v' class='invisible'><code>fn <a href='#tymethod.keys' class='fnname'>keys</a>(&self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>></code></span></h3><div class='docblock'><p>Gets the keys that are currently in the persistence store</p> |
| </div><h3 id='tymethod.clear' class='method'><span id='clear.v' class='invisible'><code>fn <a href='#tymethod.clear' class='fnname'>clear</a>(&mut self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h3><div class='docblock'><p>Clear the persistence store so that it no longer contains any data.</p> |
| </div><h3 id='tymethod.contains_key' class='method'><span id='contains_key.v' class='invisible'><code>fn <a href='#tymethod.contains_key' class='fnname'>contains_key</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Determines if the persistence store contains the key. |
| @param key The key |
| @return @em true if the key is found in the store, @em false otherwise.</p> |
| </div></div> |
| <h2 id='implementors'>Implementors</h2> |
| <ul class='item-list' id='implementors-list'> |
| </ul><script type="text/javascript" async |
| src="../../implementors/paho_mqtt/client_persistence/trait.ClientPersistence.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>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</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> |
