mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
7 lines
No EOL
5.2 KiB
HTML
7 lines
No EOL
5.2 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="Locks that have the same behaviour as a mutex."><title>spin::mutex - 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="spin" 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 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="../../spin/index.html">spin</a><span class="version">0.9.8</span></h2></div><h2 class="location"><a href="#">Module mutex</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate spin</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>Module <a href="../index.html">spin</a>::<wbr><a class="mod" href="#">mutex</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/spin/mutex.rs.html#1-340">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Locks that have the same behaviour as a mutex.</p>
|
||
<p>The <a href="../struct.Mutex.html"><code>Mutex</code></a> in the root of the crate, can be configured using the <code>ticket_mutex</code> feature.
|
||
If it’s enabled, <a href="./struct.TicketMutex.html"><code>TicketMutex</code></a> and <a href="./struct.TicketMutexGuard.html"><code>TicketMutexGuard</code></a> will be re-exported as <a href="../struct.Mutex.html"><code>Mutex</code></a>
|
||
and <a href="../struct.MutexGuard.html"><code>MutexGuard</code></a>, otherwise the <a href="./struct.SpinMutex.html"><code>SpinMutex</code></a> and guard will be re-exported.</p>
|
||
<p><code>ticket_mutex</code> is disabled by default.</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.SpinMutex"><code>pub use self::spin::<a class="struct" href="spin/struct.SpinMutex.html" title="struct spin::mutex::spin::SpinMutex">SpinMutex</a>;</code></div></li><li><div class="item-name" id="reexport.SpinMutexGuard"><code>pub use self::spin::<a class="struct" href="spin/struct.SpinMutexGuard.html" title="struct spin::mutex::spin::SpinMutexGuard">SpinMutexGuard</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="spin/index.html" title="mod spin::mutex::spin">spin</a></div><div class="desc docblock-short">A naïve spinning mutex.</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.Mutex.html" title="struct spin::mutex::Mutex">Mutex</a></div><div class="desc docblock-short">A spin-based lock providing mutually exclusive access to data.</div></li><li><div class="item-name"><a class="struct" href="struct.MutexGuard.html" title="struct spin::mutex::MutexGuard">Mutex<wbr>Guard</a></div><div class="desc docblock-short">A generic guard that will protect some data access and
|
||
uses either a ticket lock or a normal spin mutex.</div></li></ul></section></div></main></body></html> |