mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
24 lines
17 KiB
HTML
24 lines
17 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="Asynchronously wait for GPIO pin state."><title>Wait in embedded_hal_async::digital - 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_async" 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_async/index.html">embedded_<wbr>hal_<wbr>async</a><span class="version">1.0.0</span></h2></div><h2 class="location"><a href="#">Wait</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.wait_for_any_edge">wait_for_any_edge</a></li><li><a href="#tymethod.wait_for_falling_edge">wait_for_falling_edge</a></li><li><a href="#tymethod.wait_for_high">wait_for_high</a></li><li><a href="#tymethod.wait_for_low">wait_for_low</a></li><li><a href="#tymethod.wait_for_rising_edge">wait_for_rising_edge</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Wait-for-%26mut+T">&mut T</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In embedded_<wbr>hal_<wbr>async::<wbr>digital</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_async</a>::<wbr><a href="index.html">digital</a>::<wbr><a class="trait" href="#">Wait</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_async/digital.rs.html#20-49">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Wait: <a class="trait" href="../../embedded_hal/digital/trait.ErrorType.html" title="trait embedded_hal::digital::ErrorType">ErrorType</a> {
|
|||
|
|
// Required methods
|
|||
|
|
async fn <a href="#tymethod.wait_for_high" class="fn">wait_for_high</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>>;
|
|||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.wait_for_low" class="fn">wait_for_low</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>>;
|
|||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.wait_for_rising_edge" class="fn">wait_for_rising_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>>;
|
|||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.wait_for_falling_edge" class="fn">wait_for_falling_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>>;
|
|||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.wait_for_any_edge" class="fn">wait_for_any_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>>;
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronously wait for GPIO pin state.</p>
|
|||
|
|
</div></details><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.wait_for_high" class="method"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#26">source</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_high" class="fn">wait_for_high</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Wait until the pin is high. If it is already high, return immediately.</p>
|
|||
|
|
<h5 id="note-for-implementers"><a class="doc-anchor" href="#note-for-implementers">§</a>Note for implementers</h5>
|
|||
|
|
<p>The pin may have switched back to low before the task was run after
|
|||
|
|
being woken. The future should still resolve in that case.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wait_for_low" class="method"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#33">source</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_low" class="fn">wait_for_low</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Wait until the pin is low. If it is already low, return immediately.</p>
|
|||
|
|
<h5 id="note-for-implementers-1"><a class="doc-anchor" href="#note-for-implementers-1">§</a>Note for implementers</h5>
|
|||
|
|
<p>The pin may have switched back to high before the task was run after
|
|||
|
|
being woken. The future should still resolve in that case.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wait_for_rising_edge" class="method"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#39">source</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_rising_edge" class="fn">wait_for_rising_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Wait for the pin to undergo a transition from low to high.</p>
|
|||
|
|
<p>If the pin is already high, this does <em>not</em> return immediately, it’ll wait for the
|
|||
|
|
pin to go low and then high again.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wait_for_falling_edge" class="method"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#45">source</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_falling_edge" class="fn">wait_for_falling_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Wait for the pin to undergo a transition from high to low.</p>
|
|||
|
|
<p>If the pin is already low, this does <em>not</em> return immediately, it’ll wait for the
|
|||
|
|
pin to go high and then low again.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wait_for_any_edge" class="method"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#48">source</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_any_edge" class="fn">wait_for_any_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Wait for the pin to undergo any transition, i.e low to high OR high to low.</p>
|
|||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.82.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Wait-for-%26mut+T" class="impl"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#51-76">source</a><a href="#impl-Wait-for-%26mut+T" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.Wait.html" title="trait embedded_hal_async::digital::Wait">Wait</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.Wait.html" title="trait embedded_hal_async::digital::Wait">Wait</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a></h3></section></summary><div class="impl-items"><section id="method.wait_for_high" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#53-55">source</a><a href="#method.wait_for_high" class="anchor">§</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_high" class="fn">wait_for_high</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section><section id="method.wait_for_low" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#58-60">source</a><a href="#method.wait_for_low" class="anchor">§</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_low" class="fn">wait_for_low</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section><section id="method.wait_for_rising_edge" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#63-65">source</a><a href="#method.wait_for_rising_edge" class="anchor">§</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_rising_edge" class="fn">wait_for_rising_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/trait.ErrorType.html#associatedtype.Error" title="type embedded_hal::digital::ErrorType::Error">Error</a>></h4></section><section id="method.wait_for_falling_edge" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/digital.rs.html#68-70">source</a><a href="#method.wait_for_falling_edge" class="anchor">§</a><h4 class="code-header">async fn <a href="#tymethod.wait_for_falling_edge" class="fn">wait_for_falling_edge</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../embedded_hal/digital/tra
|