mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2025-01-30 04:58:39 +01:00
Code Issues Projects Releases Packages Wiki Activity
rtic/1/api/rtic/index.html
github-merge-queue[bot] 1d82d05b6d deploy: 1a8b5f27a0
2025-01-15 20:14:41 +00:00

16 lines
No EOL
7.8 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="Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers."><title>rtic - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rtic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/rtic-rs/cortex-m-rtic/master/book/en/src/RTIC.svg"></head><body class="rustdoc mod crate"><!--[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><a class="logo-container" href="../rtic/index.html"><img src="https://raw.githubusercontent.com/rtic-rs/cortex-m-rtic/master/book/en/src/RTIC.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../rtic/index.html"><img src="https://raw.githubusercontent.com/rtic-rs/cortex-m-rtic/master/book/en/src/RTIC.svg" alt="logo"></a><h2><a href="../rtic/index.html">rtic</a><span class="version">1.1.4</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#minimum-supported-rust-version-msrv" title="Minimum Supported Rust Version (MSRV)">Minimum Supported Rust Version (MSRV)</a></li><li><a href="#semantic-versioning" title="Semantic Versioning">Semantic Versioning</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#attributes" title="Attribute Macros">Attribute Macros</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>rtic</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/rtic/lib.rs.html#1-123">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers.</p>
<p><strong>IMPORTANT</strong>: This crate is published as <a href="https://crates.io/crates/cortex-m-rtic"><code>cortex-m-rtic</code></a> on crates.io but the name of the
library is <code>rtic</code>.</p>
<p>The user level documentation can be found <a href="https://rtic.rs">here</a>.</p>
<p>Don’t forget to check the documentation of the <code>#[app]</code> attribute (listed under the reexports
section), which is the main component of the framework.</p>
<h2 id="minimum-supported-rust-version-msrv"><a class="doc-anchor" href="#minimum-supported-rust-version-msrv">§</a>Minimum Supported Rust Version (MSRV)</h2>
<p>This crate is compiled and tested with the latest toolchain (rolling) as of the release date.
If you run into compilation errors, try the latest stable release of the rust toolchain.</p>
<h2 id="semantic-versioning"><a class="doc-anchor" href="#semantic-versioning">§</a>Semantic Versioning</h2>
<p>Like the Rust project, this crate adheres to <a href="https://semver.org/spec/v2.0.0.html">SemVer</a>: breaking changes in the API and semantics
require a <em>semver bump</em> (since 1.0.0 a new major version release), with the exception of breaking changes
that fix soundness issues – those are considered bug fixes and can be landed in a new patch
release.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.rtic_monotonic"><code>pub use <a class="mod" href="../rtic_monotonic/index.html" title="mod rtic_monotonic">rtic_monotonic</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="mutex/index.html" title="mod rtic::mutex">mutex</a></div><div class="desc docblock-short">module <code>mutex::prelude</code> provides <code>Mutex</code> and multi-lock variants. Recommended over <code>mutex_prelude</code></div></li><li><div class="item-name"><a class="mod" href="mutex_prelude/index.html" title="mod rtic::mutex_prelude">mutex_<wbr>prelude</a></div><div class="desc docblock-short">Makes locks work on N-tuples, locks the mutexes from left-to-right in the tuple. These are
used to reduce rightward drift in code and to help make intentions clearer.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Exclusive.html" title="struct rtic::Exclusive">Exclusive</a></div><div class="desc docblock-short">Newtype over <code>&amp;'a mut T</code> that implements the <code>Mutex</code> trait</div></li><li><div class="item-name"><a class="struct" href="struct.RacyCell.html" title="struct rtic::RacyCell">Racy<wbr>Cell</a></div><div class="desc docblock-short">Internal replacement for <code>static mut T</code></div></li></ul><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.Monotonic.html" title="trait rtic::Monotonic">Monotonic</a></div><div class="desc docblock-short">A monotonic clock / counter definition.</div></li><li><div class="item-name"><a class="trait" href="trait.Mutex.html" title="trait rtic::Mutex">Mutex</a></div><div class="desc docblock-short">Memory safe access to shared resources</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.pend.html" title="fn rtic::pend">pend</a></div><div class="desc docblock-short">Sets the given <code>interrupt</code> as pending</div></li></ul><h2 id="attributes" class="section-header">Attribute Macros<a href="#attributes" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="attr" href="attr.app.html" title="attr rtic::app">app</a></div><div class="desc docblock-short">Attribute used to declare a RTIC application</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink