Major updates: - Complete Rust rewrite (pilot-v2/) with working MQTT client - Fixed MQTT event loop deadlock (background task pattern) - Battery telemetry for Linux (auto-detected via /sys/class/power_supply) - Home Assistant auto-discovery for all sensors and switches - Comprehensive documentation (AVANCEMENT.md, CLAUDE.md, roadmap) - Docker test environment with Mosquitto broker - Helper scripts for development and testing Features working: ✅ MQTT connectivity with LWT ✅ YAML configuration with validation ✅ Telemetry: CPU, memory, IP, battery (Linux) ✅ Commands: shutdown, reboot, sleep, screen (dry-run tested) ✅ HA discovery and integration ✅ Allowlist and cooldown protection Ready for testing on real hardware. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
93 lines
59 KiB
HTML
93 lines
59 KiB
HTML
<!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="Options to configure the behaviour of MQTT connection"><title>MqttOptions in rumqttc::v5 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">MqttOptions</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rumqttc/index.html">rumqttc</a><span class="version">0.24.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Mqtt<wbr>Options</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.authentication_data" title="authentication_data">authentication_data</a></li><li><a href="#method.authentication_method" title="authentication_method">authentication_method</a></li><li><a href="#method.broker_address" title="broker_address">broker_address</a></li><li><a href="#method.clean_start" title="clean_start">clean_start</a></li><li><a href="#method.client_id" title="client_id">client_id</a></li><li><a href="#method.connect_properties" title="connect_properties">connect_properties</a></li><li><a href="#method.connection_timeout" title="connection_timeout">connection_timeout</a></li><li><a href="#method.credentials" title="credentials">credentials</a></li><li><a href="#method.get_outgoing_inflight_upper_limit" title="get_outgoing_inflight_upper_limit">get_outgoing_inflight_upper_limit</a></li><li><a href="#method.keep_alive" title="keep_alive">keep_alive</a></li><li><a href="#method.last_will" title="last_will">last_will</a></li><li><a href="#method.manual_acks" title="manual_acks">manual_acks</a></li><li><a href="#method.max_packet_size" title="max_packet_size">max_packet_size</a></li><li><a href="#method.network_options" title="network_options">network_options</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.pending_throttle" title="pending_throttle">pending_throttle</a></li><li><a href="#method.receive_maximum" title="receive_maximum">receive_maximum</a></li><li><a href="#method.request_channel_capacity" title="request_channel_capacity">request_channel_capacity</a></li><li><a href="#method.request_problem_info" title="request_problem_info">request_problem_info</a></li><li><a href="#method.request_response_info" title="request_response_info">request_response_info</a></li><li><a href="#method.set_authentication_data" title="set_authentication_data">set_authentication_data</a></li><li><a href="#method.set_authentication_method" title="set_authentication_method">set_authentication_method</a></li><li><a href="#method.set_clean_start" title="set_clean_start">set_clean_start</a></li><li><a href="#method.set_connect_properties" title="set_connect_properties">set_connect_properties</a></li><li><a href="#method.set_connection_timeout" title="set_connection_timeout">set_connection_timeout</a></li><li><a href="#method.set_credentials" title="set_credentials">set_credentials</a></li><li><a href="#method.set_keep_alive" title="set_keep_alive">set_keep_alive</a></li><li><a href="#method.set_last_will" title="set_last_will">set_last_will</a></li><li><a href="#method.set_manual_acks" title="set_manual_acks">set_manual_acks</a></li><li><a href="#method.set_max_packet_size" title="set_max_packet_size">set_max_packet_size</a></li><li><a href="#method.set_network_options" title="set_network_options">set_network_options</a></li><li><a href="#method.set_outgoing_inflight_upper_limit" title="set_outgoing_inflight_upper_limit">set_outgoing_inflight_upper_limit</a></li><li><a href="#method.set_pending_throttle" title="set_pending_throttle">set_pending_throttle</a></li><li><a href="#method.set_receive_maximum" title="set_receive_maximum">set_receive_maximum</a></li><li><a href="#method.set_request_channel_capacity" title="set_request_channel_capacity">set_request_channel_capacity</a></li><li><a href="#method.set_request_problem_info" title="set_request_problem_info">set_request_problem_info</a></li><li><a href="#method.set_request_response_info" title="set_request_response_info">set_request_response_info</a></li><li><a href="#method.set_topic_alias_max" title="set_topic_alias_max">set_topic_alias_max</a></li><li><a href="#method.set_transport" title="set_transport">set_transport</a></li><li><a href="#method.set_user_properties" title="set_user_properties">set_user_properties</a></li><li><a href="#method.topic_alias_max" title="topic_alias_max">topic_alias_max</a></li><li><a href="#method.transport" title="transport">transport</a></li><li><a href="#method.user_properties" title="user_properties">user_properties</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-MqttOptions" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-MqttOptions" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-MqttOptions" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-MqttOptions" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-MqttOptions" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Send-for-MqttOptions" title="Send">Send</a></li><li><a href="#impl-Sync-for-MqttOptions" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-MqttOptions" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rumqttc::<wbr>v5</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">rumqttc</a>::<wbr><a href="index.html">v5</a></div><h1>Struct <span class="struct">Mqtt<wbr>Options</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rumqttc/v5/mod.rs.html#64-107">Source</a> </span></div><pre class="rust item-decl"><code>pub struct MqttOptions { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Options to configure the behaviour of MQTT connection</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-MqttOptions" class="impl"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#109-529">Source</a><a href="#impl-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#119-143">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a><S: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, T: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(
|
||
id: S,
|
||
host: T,
|
||
port: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>,
|
||
) -> <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h4></section></summary><div class="docblock"><p>Create an <a href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions"><code>MqttOptions</code></a> object that contains default values for all settings other than</p>
|
||
<ul>
|
||
<li>id: A string to identify the device connecting to a broker</li>
|
||
<li>host: The broker’s domain name or IP address</li>
|
||
<li>port: The port number on which broker must be listening for incoming connections</li>
|
||
</ul>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>options = MqttOptions::new(<span class="string">"123"</span>, <span class="string">"localhost"</span>, <span class="number">1883</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.broker_address" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#179-181">Source</a><h4 class="code-header">pub fn <a href="#method.broker_address" class="fn">broker_address</a>(&self) -> (<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>)</h4></section></summary><div class="docblock"><p>Broker address</p>
|
||
</div></details><section id="method.set_last_will" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#183-186">Source</a><h4 class="code-header">pub fn <a href="#method.set_last_will" class="fn">set_last_will</a>(&mut self, will: <a class="struct" href="mqttbytes/v5/struct.LastWill.html" title="struct rumqttc::v5::mqttbytes::v5::LastWill">LastWill</a>) -> &mut Self</h4></section><section id="method.last_will" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#188-190">Source</a><h4 class="code-header">pub fn <a href="#method.last_will" class="fn">last_will</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="mqttbytes/v5/struct.LastWill.html" title="struct rumqttc::v5::mqttbytes::v5::LastWill">LastWill</a>></h4></section><section id="method.set_transport" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#212-215">Source</a><h4 class="code-header">pub fn <a href="#method.set_transport" class="fn">set_transport</a>(&mut self, transport: <a class="enum" href="../enum.Transport.html" title="enum rumqttc::Transport">Transport</a>) -> &mut Self</h4></section><section id="method.transport" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#217-219">Source</a><h4 class="code-header">pub fn <a href="#method.transport" class="fn">transport</a>(&self) -> <a class="enum" href="../enum.Transport.html" title="enum rumqttc::Transport">Transport</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.set_keep_alive" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#223-228">Source</a><h4 class="code-header">pub fn <a href="#method.set_keep_alive" class="fn">set_keep_alive</a>(&mut self, duration: <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Set number of seconds after which client should ping the broker
|
||
if there is no other data exchange</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.keep_alive" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#231-233">Source</a><h4 class="code-header">pub fn <a href="#method.keep_alive" class="fn">keep_alive</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></h4></section></summary><div class="docblock"><p>Keep alive time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.client_id" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#236-238">Source</a><h4 class="code-header">pub fn <a href="#method.client_id" class="fn">client_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Client identifier</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_clean_start" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#246-249">Source</a><h4 class="code-header">pub fn <a href="#method.set_clean_start" class="fn">set_clean_start</a>(&mut self, clean_start: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.bool.html">bool</a>) -> &mut Self</h4></section></summary><div class="docblock"><p><code>clean_start = true</code> removes all the state from queues & instructs the broker
|
||
to clean all the client state when client disconnects.</p>
|
||
<p>When set <code>false</code>, broker will hold the client state and performs pending
|
||
operations on the client when reconnection with same <code>client_id</code>
|
||
happens. Local queue state is also held to retransmit packets after reconnection.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.clean_start" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#252-254">Source</a><h4 class="code-header">pub fn <a href="#method.clean_start" class="fn">clean_start</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Clean session</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_credentials" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#257-264">Source</a><h4 class="code-header">pub fn <a href="#method.set_credentials" class="fn">set_credentials</a><U: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, P: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(
|
||
&mut self,
|
||
username: U,
|
||
password: P,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>Username and password</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.credentials" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#267-269">Source</a><h4 class="code-header">pub fn <a href="#method.credentials" class="fn">credentials</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)></h4></section></summary><div class="docblock"><p>Security options</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_request_channel_capacity" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#272-275">Source</a><h4 class="code-header">pub fn <a href="#method.set_request_channel_capacity" class="fn">set_request_channel_capacity</a>(&mut self, capacity: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.usize.html">usize</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Set request channel capacity</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.request_channel_capacity" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#278-280">Source</a><h4 class="code-header">pub fn <a href="#method.request_channel_capacity" class="fn">request_channel_capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Request channel capacity</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_pending_throttle" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#283-286">Source</a><h4 class="code-header">pub fn <a href="#method.set_pending_throttle" class="fn">set_pending_throttle</a>(&mut self, duration: <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Enables throttling and sets outoing message rate to the specified ‘rate’</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.pending_throttle" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#289-291">Source</a><h4 class="code-header">pub fn <a href="#method.pending_throttle" class="fn">pending_throttle</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></h4></section></summary><div class="docblock"><p>Outgoing message rate</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_connection_timeout" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#294-297">Source</a><h4 class="code-header">pub fn <a href="#method.set_connection_timeout" class="fn">set_connection_timeout</a>(&mut self, timeout: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u64.html">u64</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>set connection timeout in secs</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.connection_timeout" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#300-302">Source</a><h4 class="code-header">pub fn <a href="#method.connection_timeout" class="fn">connection_timeout</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u64.html">u64</a></h4></section></summary><div class="docblock"><p>get timeout in secs</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_connect_properties" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#305-308">Source</a><h4 class="code-header">pub fn <a href="#method.set_connect_properties" class="fn">set_connect_properties</a>(
|
||
&mut self,
|
||
properties: <a class="struct" href="mqttbytes/v5/struct.ConnectProperties.html" title="struct rumqttc::v5::mqttbytes::v5::ConnectProperties">ConnectProperties</a>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.connect_properties" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#311-313">Source</a><h4 class="code-header">pub fn <a href="#method.connect_properties" class="fn">connect_properties</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="mqttbytes/v5/struct.ConnectProperties.html" title="struct rumqttc::v5::mqttbytes::v5::ConnectProperties">ConnectProperties</a>></h4></section></summary><div class="docblock"><p>get connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_receive_maximum" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#316-325">Source</a><h4 class="code-header">pub fn <a href="#method.set_receive_maximum" class="fn">set_receive_maximum</a>(&mut self, recv_max: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>>) -> &mut Self</h4></section></summary><div class="docblock"><p>set receive maximum on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.receive_maximum" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#328-334">Source</a><h4 class="code-header">pub fn <a href="#method.receive_maximum" class="fn">receive_maximum</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>></h4></section></summary><div class="docblock"><p>get receive maximum from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_max_packet_size" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#337-346">Source</a><h4 class="code-header">pub fn <a href="#method.set_max_packet_size" class="fn">set_max_packet_size</a>(&mut self, max_size: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u32.html">u32</a>>) -> &mut Self</h4></section></summary><div class="docblock"><p>set max packet size on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.max_packet_size" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#349-355">Source</a><h4 class="code-header">pub fn <a href="#method.max_packet_size" class="fn">max_packet_size</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u32.html">u32</a>></h4></section></summary><div class="docblock"><p>get max packet size from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_topic_alias_max" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#358-367">Source</a><h4 class="code-header">pub fn <a href="#method.set_topic_alias_max" class="fn">set_topic_alias_max</a>(&mut self, topic_alias_max: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>>) -> &mut Self</h4></section></summary><div class="docblock"><p>set max topic alias on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.topic_alias_max" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#370-376">Source</a><h4 class="code-header">pub fn <a href="#method.topic_alias_max" class="fn">topic_alias_max</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>></h4></section></summary><div class="docblock"><p>get max topic alias from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_request_response_info" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#379-388">Source</a><h4 class="code-header">pub fn <a href="#method.set_request_response_info" class="fn">set_request_response_info</a>(
|
||
&mut self,
|
||
request_response_info: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u8.html">u8</a>>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set request response info on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.request_response_info" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#391-397">Source</a><h4 class="code-header">pub fn <a href="#method.request_response_info" class="fn">request_response_info</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u8.html">u8</a>></h4></section></summary><div class="docblock"><p>get request response info from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_request_problem_info" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#400-409">Source</a><h4 class="code-header">pub fn <a href="#method.set_request_problem_info" class="fn">set_request_problem_info</a>(
|
||
&mut self,
|
||
request_problem_info: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u8.html">u8</a>>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set request problem info on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.request_problem_info" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#412-418">Source</a><h4 class="code-header">pub fn <a href="#method.request_problem_info" class="fn">request_problem_info</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u8.html">u8</a>></h4></section></summary><div class="docblock"><p>get request problem info from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_user_properties" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#421-430">Source</a><h4 class="code-header">pub fn <a href="#method.set_user_properties" class="fn">set_user_properties</a>(
|
||
&mut self,
|
||
user_properties: <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><(<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set user properties on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.user_properties" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#433-439">Source</a><h4 class="code-header">pub fn <a href="#method.user_properties" class="fn">user_properties</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><(<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)></h4></section></summary><div class="docblock"><p>get user properties from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_authentication_method" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#442-454">Source</a><h4 class="code-header">pub fn <a href="#method.set_authentication_method" class="fn">set_authentication_method</a>(
|
||
&mut self,
|
||
authentication_method: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set authentication method on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.authentication_method" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#457-463">Source</a><h4 class="code-header">pub fn <a href="#method.authentication_method" class="fn">authentication_method</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.92.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></h4></section></summary><div class="docblock"><p>get authentication method from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_authentication_data" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#466-475">Source</a><h4 class="code-header">pub fn <a href="#method.set_authentication_data" class="fn">set_authentication_data</a>(
|
||
&mut self,
|
||
authentication_data: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Bytes>,
|
||
) -> &mut Self</h4></section></summary><div class="docblock"><p>set authentication data on connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.authentication_data" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#478-484">Source</a><h4 class="code-header">pub fn <a href="#method.authentication_data" class="fn">authentication_data</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Bytes></h4></section></summary><div class="docblock"><p>get authentication data from connection properties</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_manual_acks" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#487-490">Source</a><h4 class="code-header">pub fn <a href="#method.set_manual_acks" class="fn">set_manual_acks</a>(&mut self, manual_acks: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.bool.html">bool</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>set manual acknowledgements</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.manual_acks" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#493-495">Source</a><h4 class="code-header">pub fn <a href="#method.manual_acks" class="fn">manual_acks</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>get manual acknowledgements</p>
|
||
</div></details><section id="method.network_options" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#497-499">Source</a><h4 class="code-header">pub fn <a href="#method.network_options" class="fn">network_options</a>(&self) -> <a class="struct" href="../struct.NetworkOptions.html" title="struct rumqttc::NetworkOptions">NetworkOptions</a></h4></section><section id="method.set_network_options" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#501-504">Source</a><h4 class="code-header">pub fn <a href="#method.set_network_options" class="fn">set_network_options</a>(
|
||
&mut self,
|
||
network_options: <a class="struct" href="../struct.NetworkOptions.html" title="struct rumqttc::NetworkOptions">NetworkOptions</a>,
|
||
) -> &mut Self</h4></section><details class="toggle method-toggle" open><summary><section id="method.set_outgoing_inflight_upper_limit" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#519-522">Source</a><h4 class="code-header">pub fn <a href="#method.set_outgoing_inflight_upper_limit" class="fn">set_outgoing_inflight_upper_limit</a>(&mut self, limit: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>) -> &mut Self</h4></section></summary><div class="docblock"><p>Get the upper limit on maximum number of inflight outgoing publishes.
|
||
The server may set its own maximum inflight limit, the smaller of the two will be used.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_outgoing_inflight_upper_limit" class="method"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#526-528">Source</a><h4 class="code-header">pub fn <a href="#method.get_outgoing_inflight_upper_limit" class="fn">get_outgoing_inflight_upper_limit</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u16.html">u16</a>></h4></section></summary><div class="docblock"><p>Set the upper limit on maximum number of inflight outgoing publishes.
|
||
The server may set its own maximum inflight limit, the smaller of the two will be used.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-MqttOptions" class="impl"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#63">Source</a><a href="#impl-Clone-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#63">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.92.0/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-MqttOptions" class="impl"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#697-715">Source</a><a href="#impl-Debug-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/rumqttc/v5/mod.rs.html#698-714">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.92.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.92.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-MqttOptions" class="impl"><a href="#impl-Freeze-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section><section id="impl-RefUnwindSafe-for-MqttOptions" class="impl"><a href="#impl-RefUnwindSafe-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section><section id="impl-Send-for-MqttOptions" class="impl"><a href="#impl-Send-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section><section id="impl-Sync-for-MqttOptions" class="impl"><a href="#impl-Sync-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section><section id="impl-Unpin-for-MqttOptions" class="impl"><a href="#impl-Unpin-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section><section id="impl-UnwindSafe-for-MqttOptions" class="impl"><a href="#impl-UnwindSafe-for-MqttOptions" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.MqttOptions.html" title="struct rumqttc::v5::MqttOptions">MqttOptions</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.92.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.92.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.92.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/clone.rs.html#515">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/clone.rs.html#517">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.92.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/alloc/borrow.rs.html#85-87">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/alloc/borrow.rs.html#89">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/alloc/borrow.rs.html#90">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/alloc/borrow.rs.html#94">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.92.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.92.0/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.92.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |