deploy: 54b20a5

bluerobotics_ping/common/struct.Device.html

@@ -2,15 +2,15 @@
     <main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../bluerobotics_ping/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">bluerobotics_ping</a>::<wbr><a href="index.html">common</a>::<wbr><a class="struct" href="#">Device</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#14-16">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Device {
     pub common: <a class="struct" href="../device/struct.Common.html" title="struct bluerobotics_ping::device::Common">Common</a>,
 }</code></pre><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.common" class="structfield section-header"><a href="#structfield.common" class="anchor field">§</a><code>common: <a class="struct" href="../device/struct.Common.html" title="struct bluerobotics_ping::device::Common">Common</a></code></span><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-Device" class="impl"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#299-327">source</a><a href="#impl-Device" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Device.html" title="struct bluerobotics_ping::common::Device">Device</a></h3></section></summary><div class="impl-items"><section id="method.new" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#300-307">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>&lt;T&gt;(io: T) -&gt; Self<div class="where">where
-    T: <a class="trait" href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a> + <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section><details class="toggle method-toggle" open><summary><section id="method.protocol_version" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#309-311">source</a><h4 class="code-header">pub async fn <a href="#method.protocol_version" class="fn">protocol_version</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.ProtocolVersionStruct.html" title="struct bluerobotics_ping::common::ProtocolVersionStruct">ProtocolVersionStruct</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section></summary><div class="docblock"><p>The protocol version</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.set_device_id" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#315-322">source</a><h4 class="code-header">pub async fn <a href="#method.set_device_id" class="fn">set_device_id</a>(&amp;self, device_id: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section></summary><div class="docblock"><p>Set the device ID.</p>
+    T: <a class="trait" href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a> + <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section><details class="toggle method-toggle" open><summary><section id="method.set_device_id" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#311-318">source</a><h4 class="code-header">pub async fn <a href="#method.set_device_id" class="fn">set_device_id</a>(&amp;self, device_id: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section></summary><div class="docblock"><p>Set the device ID.</p>
 <h5 id="arguments"><a class="doc-anchor" href="#arguments">§</a>Arguments</h5>
 <ul>
 <li><code>device_id</code> - Device ID (1-254). 0 is unknown and 255 is reserved for broadcast messages.</li>
 </ul>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.device_information" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#324-326">source</a><h4 class="code-header">pub async fn <a href="#method.device_information" class="fn">device_information</a>(
+</div></details><details class="toggle method-toggle" open><summary><section id="method.device_information" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#320-322">source</a><h4 class="code-header">pub async fn <a href="#method.device_information" class="fn">device_information</a>(
     &amp;self
 ) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.DeviceInformationStruct.html" title="struct bluerobotics_ping::common::DeviceInformationStruct">DeviceInformationStruct</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section></summary><div class="docblock"><p>Device information</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.protocol_version" class="method"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#324-326">source</a><h4 class="code-header">pub async fn <a href="#method.protocol_version" class="fn">protocol_version</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.ProtocolVersionStruct.html" title="struct bluerobotics_ping::common::ProtocolVersionStruct">ProtocolVersionStruct</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section></summary><div class="docblock"><p>The protocol version</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-PingDevice-for-Device" class="impl"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#17-24">source</a><a href="#impl-PingDevice-for-Device" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../device/trait.PingDevice.html" title="trait bluerobotics_ping::device::PingDevice">PingDevice</a> for <a class="struct" href="struct.Device.html" title="struct bluerobotics_ping::common::Device">Device</a></h3></section></summary><div class="impl-items"><section id="method.get_common" class="method trait-impl"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#18-20">source</a><a href="#method.get_common" class="anchor">§</a><h4 class="code-header">fn <a href="../device/trait.PingDevice.html#tymethod.get_common" class="fn">get_common</a>(&amp;self) -&gt; &amp;<a class="struct" href="../device/struct.Common.html" title="struct bluerobotics_ping::device::Common">Common</a></h4></section><section id="method.get_mut_common" class="method trait-impl"><a class="src rightside" href="../../src/bluerobotics_ping/home/runner/work/ping-rs/ping-rs/target/debug/build/bluerobotics-ping-6439afb41037b590/out/common.rs.html#21-23">source</a><a href="#method.get_mut_common" class="anchor">§</a><h4 class="code-header">fn <a href="../device/trait.PingDevice.html#tymethod.get_mut_common" class="fn">get_mut_common</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../device/struct.Common.html" title="struct bluerobotics_ping::device::Common">Common</a></h4></section><section id="method.subscribe" class="method trait-impl"><a class="src rightside" href="../../src/bluerobotics_ping/device.rs.html#102-104">source</a><a href="#method.subscribe" class="anchor">§</a><h4 class="code-header">fn <a href="../device/trait.PingDevice.html#method.subscribe" class="fn">subscribe</a>(&amp;self) -&gt; <a class="struct" href="../../tokio/sync/broadcast/struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;<a class="struct" href="../message/struct.ProtocolMessage.html" title="struct bluerobotics_ping::message::ProtocolMessage">ProtocolMessage</a>&gt;</h4></section><section id="method.send_general_request" class="method trait-impl"><a class="src rightside" href="../../src/bluerobotics_ping/device.rs.html#106-117">source</a><a href="#method.send_general_request" class="anchor">§</a><h4 class="code-header">async fn <a href="../device/trait.PingDevice.html#method.send_general_request" class="fn">send_general_request</a>(&amp;self, requested_id: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u16.html">u16</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="enum" href="../error/enum.PingError.html" title="enum bluerobotics_ping::error::PingError">PingError</a>&gt;</h4></section><section id="method.wait_for_message" class="method trait-impl"><a class="src rightside" href="../../src/bluerobotics_ping/device.rs.html#119-147">source</a><a href="#method.wait_for_message" class="anchor">§</a><h4 class="code-header">async fn <a href="../device/trait.PingDevice.html#method.wait_for_message" class="fn">wait_for_message</a>&lt;T&gt;(
     &amp;self,
     receiver: <a class="struct" href="../../tokio/sync/broadcast/struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;<a class="struct" href="../message/struct.ProtocolMessage.html" title="struct bluerobotics_ping::message::ProtocolMessage">ProtocolMessage</a>&gt;