| <!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 `MessageBuilder` struct in crate `paho_mqtt`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, MessageBuilder"> |
| |
| <title>paho_mqtt::message::MessageBuilder - 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 MessageBuilder</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>paho_mqtt</a>::<wbr><a href='index.html'>message</a></p><script>window.sidebarCurrent = {name: 'MessageBuilder', 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'>message</a>::<wbr><a class="struct" href=''>MessageBuilder</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/message.rs.html#184-189' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'>pub struct MessageBuilder { /* fields omitted */ }</pre><div class='docblock'><p>Builder to create a new Message</p> |
| </div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#191-258' 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>() -> <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span></h4> |
| <div class='docblock'><p>Create a new message builder.</p> |
| </div><h4 id='method.topic' class="method"><span id='topic.v' class='invisible'><code>fn <a href='#method.topic' class='fnname'>topic</a>(self, topic: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span></h4> |
| <div class='docblock'><p>Sets the topic for the message</p> |
| |
| <h1 id='arguments' class='section-header'><a href='#arguments'>Arguments</a></h1> |
| <p><code>topic</code> The topic on which the message should be published.</p> |
| </div><h4 id='method.payload' class="method"><span id='payload.v' class='invisible'><code>fn <a href='#method.payload' class='fnname'>payload</a><V>(self, payload: V) -> <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a> <span class="where fmt-newline">where<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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>>>, </span></code></span></h4> |
| <div class='docblock'><p>Sets the payload for the message</p> |
| |
| <h1 id='arguments-1' class='section-header'><a href='#arguments-1'>Arguments</a></h1> |
| <p><code>payload</code> The binary payload of the message</p> |
| </div><h4 id='method.qos' class="method"><span id='qos.v' class='invisible'><code>fn <a href='#method.qos' class='fnname'>qos</a>(self, qos: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span></h4> |
| <div class='docblock'><p>Sets the Quality of Service for the message.</p> |
| |
| <h1 id='arguments-2' class='section-header'><a href='#arguments-2'>Arguments</a></h1> |
| <p><code>qos</code> The quality of service for the message.</p> |
| </div><h4 id='method.retained' class="method"><span id='retained.v' class='invisible'><code>fn <a href='#method.retained' class='fnname'>retained</a>(self, retained: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../paho_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span></h4> |
| <div class='docblock'><p>Sets whether or not the published message should be retained by the |
| broker.</p> |
| |
| <h1 id='arguments-3' class='section-header'><a href='#arguments-3'>Arguments</a></h1> |
| <p><code>retained</code> Set true if the message should be retained by the broker, |
| false if not.</p> |
| </div><h4 id='method.finalize' class="method"><span id='finalize.v' class='invisible'><code>fn <a href='#method.finalize' class='fnname'>finalize</a>(self) -> <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span></h4> |
| <div class='docblock'><p>Finalize the builder to create the message.</p> |
| </div></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_mqtt/message/struct.MessageBuilder.html" title="struct paho_mqtt::message::MessageBuilder">MessageBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#183' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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></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> |