| <!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 `Message` struct in crate `paho_mqtt`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, Message"> |
| |
| <title>paho_mqtt::message::Message - 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 Message</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><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: 'Message', 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=''>Message</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#33-37' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'>pub struct Message { |
| pub cmsg: <a class="struct" href="../../paho_mqtt3as_sys/struct.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</a>, |
| pub topic: <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CString.html" title="struct std::ffi::c_str::CString">CString</a>, |
| // some fields omitted |
| }</pre><div class='docblock'><p>A <code>Message</code> represents all the information passed in an MQTT PUBLISH |
| packet. |
| This is the primary data transfer mechanism.</p> |
| </div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.cmsg' class="structfield"> |
| <span id='cmsg.v' class='invisible'> |
| <code>cmsg: <a class="struct" href="../../paho_mqtt3as_sys/struct.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</a></code> |
| </span></span><span id='structfield.topic' class="structfield"> |
| <span id='topic.v' class='invisible'> |
| <code>topic: <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CString.html" title="struct std::ffi::c_str::CString">CString</a></code> |
| </span></span><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#39-132' 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><V>(topic: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, payload: V, 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.Message.html" title="struct paho_mqtt::message::Message">Message</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>Creates a new message.</p> |
| |
| <h1 id='arguments' class='section-header'><a href='#arguments'>Arguments</a></h1> |
| <ul> |
| <li><code>topic</code> The topic on which the message is published.</li> |
| <li><code>payload</code> The binary payload of the message</li> |
| <li><code>qos</code> The quality of service for message delivery (0, 1, or 2)</li> |
| </ul> |
| </div><h4 id='method.new_retained' class="method"><span id='new_retained.v' class='invisible'><code>fn <a href='#method.new_retained' class='fnname'>new_retained</a><V>(topic: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, payload: V, 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.Message.html" title="struct paho_mqtt::message::Message">Message</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>Creates a new message that will be retained by the broker. |
| This creates a message with the 'retained' flag set.</p> |
| |
| <h1 id='arguments-1' class='section-header'><a href='#arguments-1'>Arguments</a></h1> |
| <ul> |
| <li><code>topic</code> The topic on which the message is published.</li> |
| <li><code>payload</code> The binary payload of the message</li> |
| <li><code>qos</code> The quality of service for message delivery (0, 1, or 2)</li> |
| </ul> |
| </div><h4 id='method.from_c_parts' class="method"><span id='from_c_parts.v' class='invisible'><code>unsafe fn <a href='#method.from_c_parts' class='fnname'>from_c_parts</a>(topic: <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CString.html" title="struct std::ffi::c_str::CString">CString</a>, cmsg: &<a class="struct" href="../../paho_mqtt3as_sys/struct.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</a>) -> <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>Creates a new message from C language components.</p> |
| |
| <h1 id='arguments-2' class='section-header'><a href='#arguments-2'>Arguments</a></h1> |
| <ul> |
| <li><code>topic</code> The topic on which the message is published.</li> |
| <li><code>msg</code> The message struct from the C library</li> |
| </ul> |
| </div><h4 id='method.get_topic' class="method"><span id='get_topic.v' class='invisible'><code>fn <a href='#method.get_topic' class='fnname'>get_topic</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.IntoStringError.html" title="struct std::ffi::c_str::IntoStringError">IntoStringError</a>></code></span></h4> |
| <div class='docblock'><p>Gets the topic for the message. |
| Note that this copies the topic.</p> |
| </div><h4 id='method.get_payload' class="method"><span id='get_payload.v' class='invisible'><code>fn <a href='#method.get_payload' class='fnname'>get_payload</a>(&self) -> &<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></h4> |
| <div class='docblock'><p>Gets the payload of the message. |
| This returns the payload as a binary vector.</p> |
| </div><h4 id='method.get_payload_str' class="method"><span id='get_payload_str.v' class='invisible'><code>fn <a href='#method.get_payload_str' class='fnname'>get_payload_str</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.FromUtf8Error.html" title="struct alloc::string::FromUtf8Error">FromUtf8Error</a>></code></span></h4> |
| <div class='docblock'><p>Gets the payload of the message as a string. |
| Note that this clones the payload.</p> |
| </div><h4 id='method.get_qos' class="method"><span id='get_qos.v' class='invisible'><code>fn <a href='#method.get_qos' class='fnname'>get_qos</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></h4> |
| <div class='docblock'><p>Returns the Quality of Service (QOS) for the message.</p> |
| </div><h4 id='method.get_retained' class="method"><span id='get_retained.v' class='invisible'><code>fn <a href='#method.get_retained' class='fnname'>get_retained</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4> |
| <div class='docblock'><p>Gets the 'retained' flag for 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.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#32' 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><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_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#134-143' 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>() -> <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>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#145-154' 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>(&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>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>(&mut self, source: &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, 'b> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&'a <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.slice.html">&'b [</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#156-165' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>((topic, payload): <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&'a <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.slice.html">&'b [</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> Self</code></span></h4> |
| <div class='docblock'><p>Performs the conversion.</p> |
| </div></div><h3 class='impl'><span class='in-band'><code>impl<'a, 'b> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&'a <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.slice.html">&'b [</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/message.rs.html#167-178' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>((topic, payload, qos, retained): <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&'a <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.slice.html">&'b [</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> Self</code></span></h4> |
| <div class='docblock'><p>Performs the conversion.</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> |
