rtic/1/api/embedded_hal/blocking/delay/index.html
2024-12-06 13:35:18 +00:00

7 lines
No EOL
4.6 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="Delays"><title>embedded_hal::blocking::delay - 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 mod"><!--[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="#">Module delay</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#whats-the-difference-between-these-traits-and-the-timercountdown-trait" title="Whats the difference between these traits and the `timer::CountDown` trait?">Whats the difference between these traits and the <code>timer::CountDown</code> trait?</a></li></ul><h3><a href="#traits">Module Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In embedded_<wbr>hal::<wbr>blocking</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">blocking</a></span><h1>Module <span>delay</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/blocking/delay.rs.html#1-26">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Delays</p>
<h2 id="whats-the-difference-between-these-traits-and-the-timercountdown-trait"><a class="doc-anchor" href="#whats-the-difference-between-these-traits-and-the-timercountdown-trait">§</a>Whats the difference between these traits and the <code>timer::CountDown</code> trait?</h2>
<p>The <code>Timer</code> trait provides a <em>non-blocking</em> timer abstraction and its meant to be used to build
higher level abstractions like I/O operations with timeouts. OTOH, these delays traits only
provide <em>blocking</em> functionality. Note that you can also use the <code>timer::CountDown</code> trait to
implement blocking delays.</p>
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.DelayMs.html" title="trait embedded_hal::blocking::delay::DelayMs">DelayMs</a></div><div class="desc docblock-short">Millisecond delay</div></li><li><div class="item-name"><a class="trait" href="trait.DelayUs.html" title="trait embedded_hal::blocking::delay::DelayUs">DelayUs</a></div><div class="desc docblock-short">Microsecond delay</div></li></ul></section></div></main></body></html>