| <!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_message` struct in crate `paho_mqtt3as_sys`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_message"> |
| |
| <title>paho_mqtt3as_sys::MQTTAsync_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 MQTTAsync_message</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_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_mqtt3as_sys</a>::<wbr><a class="struct" href=''>MQTTAsync_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_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#1286-1332' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'><div class="docblock attributes">#[repr(C)] |
| </div>pub struct MQTTAsync_message { |
| 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 payloadlen: <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 payload: <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 qos: <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 retained: <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 dup: <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 msgid: <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>, |
| }</pre><div class='docblock'><p>A structure representing the payload and attributes of an MQTT message. The |
| message topic is not part of this structure (see MQTTAsync_publishMessage(), |
| MQTTAsync_publish(), MQTTAsync_receive(), MQTTAsync_freeMessage() |
| and MQTTAsync_messageArrived()).</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 MQTM.</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</p> |
| </div><span id='structfield.payloadlen' class="structfield"> |
| <span id='payloadlen.v' class='invisible'> |
| <code>payloadlen: <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 length of the MQTT message payload in bytes.</p> |
| </div><span id='structfield.payload' class="structfield"> |
| <span id='payload.v' class='invisible'> |
| <code>payload: <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 the payload of the MQTT message.</p> |
| </div><span id='structfield.qos' class="structfield"> |
| <span id='qos.v' class='invisible'> |
| <code>qos: <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 quality of service (QoS) assigned to the message. |
| There are three levels of QoS: |
| <DL> |
| <DT><B>QoS0</B></DT> |
| <DD>Fire and forget - the message may not be delivered</DD> |
| <DT><B>QoS1</B></DT> |
| <DD>At least once - the message will be delivered, but may be |
| delivered more than once in some circumstances.</DD> |
| <DT><B>QoS2</B></DT> |
| <DD>Once and one only - the message will be delivered exactly once.</DD> |
| </DL></p> |
| </div><span id='structfield.retained' class="structfield"> |
| <span id='retained.v' class='invisible'> |
| <code>retained: <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 retained flag serves two purposes depending on whether the message |
| it is associated with is being published or received.</p> |
| |
| <p><b>retained = true</b><br> |
| For messages being published, a true setting indicates that the MQTT |
| server should retain a copy of the message. The message will then be |
| transmitted to new subscribers to a topic that matches the message topic. |
| For subscribers registering a new subscription, the flag being true |
| indicates that the received message is not a new one, but one that has |
| been retained by the MQTT server.</p> |
| |
| <p><b>retained = false</b> <br> |
| For publishers, this ndicates that this message should not be retained |
| by the MQTT server. For subscribers, a false setting indicates this is |
| a normal message, received as a result of it being published to the |
| server.</p> |
| </div><span id='structfield.dup' class="structfield"> |
| <span id='dup.v' class='invisible'> |
| <code>dup: <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 dup flag indicates whether or not this message is a duplicate. |
| It is only meaningful when receiving QoS1 messages. When true, the |
| client application should take appropriate action to deal with the |
| duplicate message.</p> |
| </div><span id='structfield.msgid' class="structfield"> |
| <span id='msgid.v' class='invisible'> |
| <code>msgid: <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 message identifier is normally reserved for internal use by the |
| MQTT client and server.</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.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</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#1285' 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/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</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#1285' 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_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</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#1380-1382' 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) -> 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>(&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 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_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_message</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/paho_mqtt3as_sys/lib.rs.html#123-136' 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_mqtt3as_sys/struct.MQTTAsync_message.html" title="struct paho_mqtt3as_sys::MQTTAsync_message">MQTTAsync_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></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_mqtt3as_sys"; |
| </script> |
| <script src="../main.js"></script> |
| <script defer src="../search-index.js"></script> |
| </body> |
| </html> |