rtic/1/api/embedded_hal/digital/v1/trait.OutputPin.html

18 lines
6.9 KiB
HTML
Raw Permalink Normal View History

<!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="Single digital push-pull output pin"><title>OutputPin in embedded_hal::digital::v1 - 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="#">Output<wbr>Pin</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.set_high" title="set_high">set_high</a></li><li><a href="#tymethod.set_low" title="set_low">set_low</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>digital::<wbr>v1</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">digital</a>::<wbr><a href="index.html">v1</a></span><h1>Trait <span class="trait">OutputPin</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/digital/v1.rs.html#13-25">source</a> </span></div><pre class="rust item-decl"><code>pub trait OutputPin {
// Required methods
fn <a href="#tymethod.set_low" class="fn">set_low</a>(&amp;mut self);
<span class="item-spacer"></span> fn <a href="#tymethod.set_high" class="fn">set_high</a>(&amp;mut self);
}</code></pre><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.2.2: Deprecated because the methods cannot return errors. Users should use the traits in digital::v2.</span></div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Single digital push-pull output pin</p>
<p><em>This version of the trait is now deprecated. Please use the new <code>OutputPin</code> trait in
<code>digital::v2::OutputPin</code></em>.</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.set_low" class="method"><a class="src rightside" href="../../../src/embedded_hal/digital/v1.rs.html#18">source</a><h4 class="code-header">fn <a href="#tymethod.set_low" class="fn">set_low</a>(&amp;mut self)</h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.2.2: Deprecated because the methods cannot return errors. Users should use the traits in digital::v2.</span></div></span></summary><div class="docblock"><p>Drives the pin low</p>
<p><em>NOTE</em> the actual electrical state of the pin may not actually be low, e.g. due to external
electrical sources</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_high" class="method"><a class="src rightside" href="../../../src/embedded_hal/digital/v1.rs.html#24">source</a><h4 class="code-header">fn <a href="#tymethod.set_high" class="fn">set_high</a>(&amp;mut self)</h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.2.2: Deprecated because the methods cannot return errors. Users should use the traits in digital::v2.</span></div></span></summary><div class="docblock"><p>Drives the pin high</p>
<p><em>NOTE</em> the actual electrical state of the pin may not actually be high, e.g. due to external
electrical sources</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-OutputPin-for-OldOutputPin%3CT%3E" class="impl"><a class="src rightside" href="../../../src/embedded_hal/digital/v1_compat.rs.html#76-88">source</a><a href="#impl-OutputPin-for-OldOutputPin%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, E&gt; <a class="trait" href="trait.OutputPin.html" title="trait embedded_hal::digital::v1::OutputPin">OutputPin</a> for <a class="struct" href="../v1_compat/struct.OldOutputPin.html" title="struct embedded_hal::digital::v1_compat::OldOutputPin">OldOutputPin</a>&lt;T&gt;<div class="where">where
T: <a class="trait" href="../v2/trait.OutputPin.html" title="trait embedded_hal::digital::v2::OutputPin">OutputPin</a>&lt;Error = E&gt;,
E: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h3></section><div class="docblock"><p>Implementation of <code>v1::OutputPin</code> trait for fallible <code>v2::OutputPin</code> output pins
where errors will panic.</p>
</div></div><script src="../../../trait.impl/embedded_hal/digital/v1/trait.OutputPin.js" async></script></section></div></main></body></html>