mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-23 20:22:51 +01:00
15 lines
No EOL
6.4 KiB
HTML
15 lines
No EOL
6.4 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="Methods required for a critical section implementation."><title>Impl in critical_section - 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="critical_section" 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="../critical_section/index.html">critical_<wbr>section</a><span class="version">1.2.0</span></h2></div><h2 class="location"><a href="#">Impl</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.acquire">acquire</a></li><li><a href="#tymethod.release">release</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 crate critical_<wbr>section</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">critical_section</a>::<wbr><a class="trait" href="#">Impl</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/critical_section/lib.rs.html#258-272">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe trait Impl {
|
|
// Required methods
|
|
unsafe fn <a href="#tymethod.acquire" class="fn">acquire</a>() -> <a class="type" href="type.RawRestoreState.html" title="type critical_section::RawRestoreState">RawRestoreState</a>;
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.release" class="fn">release</a>(restore_state: <a class="type" href="type.RawRestoreState.html" title="type critical_section::RawRestoreState">RawRestoreState</a>);
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Methods required for a critical section implementation.</p>
|
|
<p>This trait is not intended to be used except when implementing a critical section.</p>
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|
<p>Implementations must uphold the contract specified in <a href="fn.acquire.html" title="fn critical_section::acquire"><code>crate::acquire</code></a> and <a href="fn.release.html" title="fn critical_section::release"><code>crate::release</code></a>.</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.acquire" class="method"><a class="src rightside" href="../src/critical_section/lib.rs.html#264">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.acquire" class="fn">acquire</a>() -> <a class="type" href="type.RawRestoreState.html" title="type critical_section::RawRestoreState">RawRestoreState</a></h4></section></summary><div class="docblock"><p>Acquire the critical section.</p>
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|
<p>Callers must uphold the contract specified in <a href="fn.acquire.html" title="fn critical_section::acquire"><code>crate::acquire</code></a> and <a href="fn.release.html" title="fn critical_section::release"><code>crate::release</code></a>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.release" class="method"><a class="src rightside" href="../src/critical_section/lib.rs.html#271">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.release" class="fn">release</a>(restore_state: <a class="type" href="type.RawRestoreState.html" title="type critical_section::RawRestoreState">RawRestoreState</a>)</h4></section></summary><div class="docblock"><p>Release the critical section.</p>
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
|
<p>Callers must uphold the contract specified in <a href="fn.acquire.html" title="fn critical_section::acquire"><code>crate::acquire</code></a> and <a href="fn.release.html" title="fn critical_section::release"><code>crate::release</code></a>.</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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/critical_section/trait.Impl.js" async></script></section></div></main></body></html> |