mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-02 00:14:33 +01:00
30 lines
8.7 KiB
HTML
30 lines
8.7 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="A CAN interface that is able to transmit and receive frames."><title>Can in embedded_hal::can::nb - 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-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-3b12f09e550e0385.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><h2 class="location"><a href="#">Can</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li><li><a href="#associatedtype.Frame">Frame</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.receive">receive</a></li><li><a href="#tymethod.transmit">transmit</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In embedded_<wbr>hal::<wbr>can::<wbr>nb</a></h2></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"><h1>Trait <a href="../../index.html">embedded_hal</a>::<wbr><a href="../index.html">can</a>::<wbr><a href="index.html">nb</a>::<wbr><a class="trait" href="#">Can</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/embedded_hal/can/nb.rs.html#4-28">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Can {
|
||
|
|
type <a href="#associatedtype.Frame" class="associatedtype">Frame</a>: <a class="trait" href="../trait.Frame.html" title="trait embedded_hal::can::Frame">Frame</a>;
|
||
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="../trait.Error.html" title="trait embedded_hal::can::Error">Error</a>;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.transmit" class="fn">transmit</a>(
|
||
|
|
&mut self,
|
||
|
|
frame: &Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>,
|
||
|
|
) -> Result<<a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>>, Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Error" title="type embedded_hal::can::nb::Can::Error">Error</a>>;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.receive" class="fn">receive</a>(&mut self) -> Result<Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>, Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Error" title="type embedded_hal::can::nb::Can::Error">Error</a>>;
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A CAN interface that is able to transmit and receive frames.</p>
|
||
|
|
</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.Frame" class="method"><a class="src rightside" href="../../../src/embedded_hal/can/nb.rs.html#6">source</a><h4 class="code-header">type <a href="#associatedtype.Frame" class="associatedtype">Frame</a>: <a class="trait" href="../trait.Frame.html" title="trait embedded_hal::can::Frame">Frame</a></h4></section></summary><div class="docblock"><p>Associated frame type.</p>
|
||
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../../src/embedded_hal/can/nb.rs.html#9">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="../trait.Error.html" title="trait embedded_hal::can::Error">Error</a></h4></section></summary><div class="docblock"><p>Associated error type.</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.transmit" class="method"><a class="src rightside" href="../../../src/embedded_hal/can/nb.rs.html#24">source</a><h4 class="code-header">fn <a href="#tymethod.transmit" class="fn">transmit</a>(
|
||
|
|
&mut self,
|
||
|
|
frame: &Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>,
|
||
|
|
) -> Result<<a class="enum" href="https://doc.rust-lang.org/1.82.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>>, Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Error" title="type embedded_hal::can::nb::Can::Error">Error</a>></h4></section></summary><div class="docblock"><p>Puts a frame in the transmit buffer to be sent on the bus.</p>
|
||
|
|
<p>If the transmit buffer is full, this function will try to replace a pending
|
||
|
|
lower priority frame and return the frame that was replaced.
|
||
|
|
Returns <code>Err(WouldBlock)</code> if the transmit buffer is full and no frame can be
|
||
|
|
replaced.</p>
|
||
|
|
<h5 id="notes-for-implementers"><a class="doc-anchor" href="#notes-for-implementers">§</a>Notes for implementers</h5>
|
||
|
|
<ul>
|
||
|
|
<li>Frames of equal identifier shall be transmited in FIFO fashion when more
|
||
|
|
than one transmit buffer is available.</li>
|
||
|
|
<li>When replacing pending frames make sure the frame is not in the process of
|
||
|
|
being send to the bus.</li>
|
||
|
|
</ul>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.receive" class="method"><a class="src rightside" href="../../../src/embedded_hal/can/nb.rs.html#27">source</a><h4 class="code-header">fn <a href="#tymethod.receive" class="fn">receive</a>(&mut self) -> Result<Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Frame" title="type embedded_hal::can::nb::Can::Frame">Frame</a>, Self::<a class="associatedtype" href="trait.Can.html#associatedtype.Error" title="type embedded_hal::can::nb::Can::Error">Error</a>></h4></section></summary><div class="docblock"><p>Returns a received frame if available.</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/can/nb/trait.Can.js" async></script></section></div></main></body></html>
|