mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 20:09:33 +01:00
26 lines
6.9 KiB
HTML
26 lines
6.9 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="Full duplex (master mode)"><title>FullDuplex in embedded_hal::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" 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 trait"><!--[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/index.html">embedded_<wbr>hal</a><span class="version">0.2.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Full<wbr>Duplex</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#notes" title="Notes">Notes</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.read" title="read">read</a></li><li><a href="#tymethod.send" title="send">send</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In embedded_<wbr>hal::<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</a>::<wbr><a href="index.html">spi</a></span><h1>Trait <span class="trait">FullDuplex</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/spi.rs.html#15-27">source</a> </span></div><pre class="rust item-decl"><code>pub trait FullDuplex<Word> {
|
|||
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
|||
|
|
|
|||
|
|
// Required methods
|
|||
|
|
fn <a href="#tymethod.read" class="fn">read</a>(&mut self) -> Result<Word, Self::<a class="associatedtype" href="trait.FullDuplex.html#associatedtype.Error" title="type embedded_hal::spi::FullDuplex::Error">Error</a>>;
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.send" class="fn">send</a>(&mut self, word: Word) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.FullDuplex.html#associatedtype.Error" title="type embedded_hal::spi::FullDuplex::Error">Error</a>>;
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Full duplex (master mode)</p>
|
|||
|
|
<h2 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h2>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>It’s the task of the user of this interface to manage the slave select lines</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Due to how full duplex SPI works each <code>read</code> call must be preceded by a <code>send</code> call.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Some SPIs can work with 8-bit <em>and</em> 16-bit words. You can overload this trait with different
|
|||
|
|
<code>Word</code> types to allow operation in both modes.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#17">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>An enumeration of SPI errors</p>
|
|||
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.read" class="method"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.read" class="fn">read</a>(&mut self) -> Result<Word, Self::<a class="associatedtype" href="trait.FullDuplex.html#associatedtype.Error" title="type embedded_hal::spi::FullDuplex::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads the word stored in the shift register</p>
|
|||
|
|
<p><strong>NOTE</strong> A word must be sent to the slave before attempting to call this
|
|||
|
|
method.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.send" class="method"><a class="src rightside" href="../../src/embedded_hal/spi.rs.html#26">source</a><h4 class="code-header">fn <a href="#tymethod.send" class="fn">send</a>(&mut self, word: Word) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.FullDuplex.html#associatedtype.Error" title="type embedded_hal::spi::FullDuplex::Error">Error</a>></h4></section></summary><div class="docblock"><p>Sends a word to the slave</p>
|
|||
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/embedded_hal/spi/trait.FullDuplex.js" async></script></section></div></main></body></html>
|