rtic/1/api/spin/barrier/index.html
2024-10-24 05:57:30 +00:00

14 lines
No EOL
4.7 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="Synchronization primitive allowing multiple threads to synchronize the beginning of some computation."><title>spin::barrier - 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 barrier</a></h2><div class="sidebar-elems"><section><ul class="block"><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="#">barrier</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/barrier.rs.html#1-239">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Synchronization primitive allowing multiple threads to synchronize the
beginning of some computation.</p>
<p>Implementation adapted from the Barrier type of the standard library. See:
<a href="https://doc.rust-lang.org/std/sync/struct.Barrier.html">https://doc.rust-lang.org/std/sync/struct.Barrier.html</a></p>
<p>Copyright 2014 The Rust Project Developers. See the COPYRIGHT
file at the top-level directory of this distribution and at
<a href="http://rust-lang.org/COPYRIGHT">http://rust-lang.org/COPYRIGHT</a>.</p>
<p>Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>&gt; or the MIT license
&lt;LICENSE-MIT or <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a>&gt;, at your
option. This file may not be copied, modified, or distributed
except according to those terms.</p>
</div></details><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.Barrier.html" title="struct spin::barrier::Barrier">Barrier</a></div><div class="desc docblock-short">A primitive that synchronizes the execution of multiple threads.</div></li><li><div class="item-name"><a class="struct" href="struct.BarrierWaitResult.html" title="struct spin::barrier::BarrierWaitResult">Barrier<wbr>Wait<wbr>Result</a></div><div class="desc docblock-short">A <code>BarrierWaitResult</code> is returned by <a href="struct.Barrier.html#method.wait"><code>wait</code></a> when all threads in the <a href="struct.Barrier.html"><code>Barrier</code></a>
have rendezvoused.</div></li></ul></section></div></main></body></html>