rtic/stable/api/embedded_hal_bus/spi/struct.AtomicDevice.html
2024-12-06 13:35:18 +00:00

73 lines
No EOL
38 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Atomics-based shared bus `SpiDevice` implementation."><title>AtomicDevice in embedded_hal_bus::spi - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="embedded_hal_bus" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../embedded_hal_bus/index.html">embedded_<wbr>hal_<wbr>bus</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Atomic<wbr>Device</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.new" title="new">new</a></li><li><a href="#method.new_no_delay" title="new_no_delay">new_no_delay</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-ErrorType-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="ErrorType">ErrorType</a></li><li><a href="#impl-SpiDevice%3CWord%3E-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="SpiDevice&#60;Word&#62;">SpiDevice&#60;Word&#62;</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="Freeze">Freeze</a></li><li><a href="#impl-Send-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" 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&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In embedded_<wbr>hal_<wbr>bus::<wbr>spi</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">embedded_hal_bus</a>::<wbr><a href="index.html">spi</a></span><h1>Struct <span class="struct">AtomicDevice</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/embedded_hal_bus/spi/atomic.rs.html#29-33">source</a> </span></div><pre class="rust item-decl"><code>pub struct AtomicDevice&lt;'a, BUS, CS, D&gt; { <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>Atomics-based shared bus <a href="../../embedded_hal/spi/trait.SpiDevice.html" title="trait embedded_hal::spi::SpiDevice"><code>SpiDevice</code></a> implementation.</p>
<p>This allows for sharing an <a href="../../embedded_hal/spi/trait.SpiBus.html" title="trait embedded_hal::spi::SpiBus"><code>SpiBus</code></a>, obtaining multiple <a href="../../embedded_hal/spi/trait.SpiDevice.html" title="trait embedded_hal::spi::SpiDevice"><code>SpiDevice</code></a> instances,
each with its own <code>CS</code> pin.</p>
<p>Sharing is implemented with a <a href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice"><code>AtomicDevice</code></a>, which consists of an <code>UnsafeCell</code> and an <code>AtomicBool</code> “locked” flag.
This means it has low overhead, like <a href="struct.RefCellDevice.html" title="struct embedded_hal_bus::spi::RefCellDevice"><code>RefCellDevice</code></a>. Aditionally, it is <code>Send</code>,
which allows sharing a single bus across multiple threads (interrupt priority level), like <a href="struct.CriticalSectionDevice.html" title="struct embedded_hal_bus::spi::CriticalSectionDevice"><code>CriticalSectionDevice</code></a>,
while not using critical sections and therefore impacting real-time performance less.</p>
<p>The downside is using a simple <code>AtomicBool</code> for locking doesnt prevent two threads from trying to lock it at once.
For example, the main thread can be doing a SPI transaction, and an interrupt fires and tries to do another. In this
case, a <code>Busy</code> error is returned that must be handled somehow, usually dropping the data or trying again later.</p>
<p>Note that retrying in a loop on <code>Busy</code> errors usually leads to deadlocks. In the above example, itll prevent the
interrupt handler from returning, which will starve the main thread and prevent it from releasing the lock. If
this is an issue for your use case, you most likely should use <a href="struct.CriticalSectionDevice.html" title="struct embedded_hal_bus::spi::CriticalSectionDevice"><code>CriticalSectionDevice</code></a> instead.</p>
<p>This primitive is particularly well-suited for applications that have external arbitration
rules that prevent <code>Busy</code> errors in the first place, such as the RTIC framework.</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-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#47-60">source</a><a href="#impl-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;</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/embedded_hal_bus/spi/atomic.rs.html#53-59">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(
bus: &amp;'a <a class="struct" href="../util/struct.AtomicCell.html" title="struct embedded_hal_bus::util::AtomicCell">AtomicCell</a>&lt;BUS&gt;,
cs: CS,
delay: D,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, CS::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>&gt;<div class="where">where
CS: <a class="trait" href="../../embedded_hal/digital/trait.OutputPin.html" title="trait embedded_hal::digital::OutputPin">OutputPin</a>,</div></h4></section></summary><div class="docblock"><p>Create a new <a href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice"><code>AtomicDevice</code></a>.</p>
<p>This sets the <code>cs</code> pin high, and returns an error if that fails. It is recommended
to set the pin high the moment its configured as an output, to avoid glitches.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AtomicDevice%3C'a,+BUS,+CS,+NoDelay%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#62-98">source</a><a href="#impl-AtomicDevice%3C'a,+BUS,+CS,+NoDelay%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS&gt; <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, <a class="struct" href="struct.NoDelay.html" title="struct embedded_hal_bus::spi::NoDelay">NoDelay</a>&gt;<div class="where">where
BUS: <a class="trait" href="../../embedded_hal/spi/trait.ErrorType.html" title="trait embedded_hal::spi::ErrorType">ErrorType</a>,
CS: <a class="trait" href="../../embedded_hal/digital/trait.OutputPin.html" title="trait embedded_hal::digital::OutputPin">OutputPin</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new_no_delay" class="method"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#87-97">source</a><h4 class="code-header">pub fn <a href="#method.new_no_delay" class="fn">new_no_delay</a>(bus: &amp;'a <a class="struct" href="../util/struct.AtomicCell.html" title="struct embedded_hal_bus::util::AtomicCell">AtomicCell</a>&lt;BUS&gt;, cs: CS) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, CS::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>&gt;<div class="where">where
CS: <a class="trait" href="../../embedded_hal/digital/trait.OutputPin.html" title="trait embedded_hal::digital::OutputPin">OutputPin</a>,</div></h4></section></summary><div class="docblock"><p>Create a new <a href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice"><code>AtomicDevice</code></a> without support for in-transaction delays.</p>
<p>This sets the <code>cs</code> pin high, and returns an error if that fails. It is recommended
to set the pin high the moment its configured as an output, to avoid glitches.</p>
<p><strong>Warning</strong>: The returned instance <em>technically</em> doesnt comply with the <code>SpiDevice</code>
contract, which mandates delay support. It is relatively rare for drivers to use
in-transaction delays, so you might still want to use this method because its more practical.</p>
<p>Note that a future version of the driver might start using delays, causing your
code to panic. This wouldnt be considered a breaking change from the driver side, because
drivers are allowed to assume <code>SpiDevice</code> implementations comply with the contract.
If you feel this risk outweighs the convenience of having <code>cargo</code> automatically upgrade
the driver crate, you might want to pin the drivers version.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>The returned device will panic if you try to execute a transaction
that contains any operations of type <a href="../../embedded_hal/spi/enum.Operation.html#variant.DelayNs" title="variant embedded_hal::spi::Operation::DelayNs"><code>Operation::DelayNs</code></a>.</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-ErrorType-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#109-115">source</a><a href="#impl-ErrorType-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="trait" href="../../embedded_hal/spi/trait.ErrorType.html" title="trait embedded_hal::spi::ErrorType">ErrorType</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
BUS: <a class="trait" href="../../embedded_hal/spi/trait.ErrorType.html" title="trait embedded_hal::spi::ErrorType">ErrorType</a>,
CS: <a class="trait" href="../../embedded_hal/digital/trait.OutputPin.html" title="trait embedded_hal::digital::OutputPin">OutputPin</a>,</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="../../src/embedded_hal_bus/spi/atomic.rs.html#114">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="enum.AtomicError.html" title="enum embedded_hal_bus::spi::AtomicError">AtomicError</a>&lt;<a class="enum" href="enum.DeviceError.html" title="enum embedded_hal_bus::spi::DeviceError">DeviceError</a>&lt;&lt;BUS as <a class="trait" href="../../embedded_hal/spi/trait.ErrorType.html" title="trait embedded_hal::spi::ErrorType">ErrorType</a>&gt;::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>, &lt;CS as <a class="trait" href="../../embedded_hal/digital/trait.ErrorType.html" title="trait embedded_hal::digital::ErrorType">ErrorType</a>&gt;::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>&gt;&gt;</h4></section></summary><div class='docblock'>Error type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SpiDevice%3CWord%3E-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#117-145">source</a><a href="#impl-SpiDevice%3CWord%3E-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, Word: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + 'static, BUS, CS, D&gt; <a class="trait" href="../../embedded_hal/spi/trait.SpiDevice.html" title="trait embedded_hal::spi::SpiDevice">SpiDevice</a>&lt;Word&gt; for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
BUS: <a class="trait" href="../../embedded_hal/spi/trait.SpiBus.html" title="trait embedded_hal::spi::SpiBus">SpiBus</a>&lt;Word&gt;,
CS: <a class="trait" href="../../embedded_hal/digital/trait.OutputPin.html" title="trait embedded_hal::digital::OutputPin">OutputPin</a>,
D: <a class="trait" href="../../embedded_hal/delay/trait.DelayNs.html" title="trait embedded_hal::delay::DelayNs">DelayNs</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.transaction" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_bus/spi/atomic.rs.html#124-144">source</a><a href="#method.transaction" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/spi/trait.SpiDevice.html#tymethod.transaction" class="fn">transaction</a>(
&amp;mut self,
operations: &amp;mut [<a class="enum" href="../../embedded_hal/spi/enum.Operation.html" title="enum embedded_hal::spi::Operation">Operation</a>&lt;'_, Word&gt;],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Perform a transaction against the device. <a href="../../embedded_hal/spi/trait.SpiDevice.html#tymethod.transaction">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#371">source</a><a href="#method.read" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.read" class="fn">read</a>(&amp;mut self, buf: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.slice.html">[Word]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Do a read within a transaction. <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.read">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#381">source</a><a href="#method.write" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.write" class="fn">write</a>(&amp;mut self, buf: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.slice.html">[Word]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Do a write within a transaction. <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.write">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.transfer" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#391">source</a><a href="#method.transfer" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.transfer" class="fn">transfer</a>(
&amp;mut self,
read: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.slice.html">[Word]</a>,
write: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.slice.html">[Word]</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Do a transfer within a transaction. <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.transfer">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.transfer_in_place" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#401">source</a><a href="#method.transfer_in_place" class="anchor">§</a><h4 class="code-header">fn <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.transfer_in_place" class="fn">transfer_in_place</a>(&amp;mut self, buf: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.slice.html">[Word]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/spi/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::spi::ErrorType::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Do an in-place transfer within a transaction. <a href="../../embedded_hal/spi/trait.SpiDevice.html#method.transfer_in_place">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-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-Freeze-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
CS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,
D: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-RefUnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;</h3></section><section id="impl-Send-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-Send-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
CS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
D: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
BUS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-Sync-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
CS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
D: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
BUS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Unpin-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-Unpin-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;<div class="where">where
CS: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
D: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="impl"><a href="#impl-UnwindSafe-for-AtomicDevice%3C'a,+BUS,+CS,+D%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, BUS, CS, D&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.AtomicDevice.html" title="struct embedded_hal_bus::spi::AtomicDevice">AtomicDevice</a>&lt;'a, BUS, CS, D&gt;</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.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.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.83.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.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.83.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.83.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.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.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-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; 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.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</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.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; 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.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</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.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</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.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</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.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>