deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions

1
crossbeam_utils/all.html Normal file
View file

@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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="../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><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></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"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.Backoff.html">Backoff</a></li><li><a href="struct.CachePadded.html">CachePadded</a></li><li><a href="atomic/struct.AtomicCell.html">atomic::AtomicCell</a></li><li><a href="sync/struct.Parker.html">sync::Parker</a></li><li><a href="sync/struct.ShardedLock.html">sync::ShardedLock</a></li><li><a href="sync/struct.ShardedLockReadGuard.html">sync::ShardedLockReadGuard</a></li><li><a href="sync/struct.ShardedLockWriteGuard.html">sync::ShardedLockWriteGuard</a></li><li><a href="sync/struct.Unparker.html">sync::Unparker</a></li><li><a href="sync/struct.WaitGroup.html">sync::WaitGroup</a></li><li><a href="thread/struct.Scope.html">thread::Scope</a></li><li><a href="thread/struct.ScopedJoinHandle.html">thread::ScopedJoinHandle</a></li><li><a href="thread/struct.ScopedThreadBuilder.html">thread::ScopedThreadBuilder</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="atomic/trait.AtomicConsume.html">atomic::AtomicConsume</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="thread/fn.scope.html">thread::scope</a></li></ul></section></div></main></body></html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/atomic/struct.AtomicCell.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/atomic/struct.AtomicCell.html">../../../crossbeam_utils/atomic/struct.AtomicCell.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/atomic/struct.AtomicCell.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/atomic/trait.AtomicConsume.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/atomic/trait.AtomicConsume.html">../../../crossbeam_utils/atomic/trait.AtomicConsume.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/atomic/trait.AtomicConsume.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,6 @@
<!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="Atomic types."><title>crossbeam_utils::atomic - 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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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="../../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module atomic</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate crossbeam_<wbr>utils</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">crossbeam_utils</a></span><h1>Module <span>atomic</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/crossbeam_utils/atomic/mod.rs.html#1-32">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Atomic types.</p>
<ul>
<li><a href="struct.AtomicCell.html" title="struct crossbeam_utils::atomic::AtomicCell"><code>AtomicCell</code></a>, a thread-safe mutable memory location.</li>
<li><a href="trait.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume"><code>AtomicConsume</code></a>, for reading from primitive atomic types with “consume” ordering.</li>
</ul>
</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.AtomicCell.html" title="struct crossbeam_utils::atomic::AtomicCell">Atomic<wbr>Cell</a></div><div class="desc docblock-short">A thread-safe mutable memory location.</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.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume">Atomic<wbr>Consume</a></div><div class="desc docblock-short">Trait which allows reading from primitive atomic types with “consume” ordering.</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["AtomicCell"],"trait":["AtomicConsume"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../crossbeam_utils/struct.Backoff.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../crossbeam_utils/struct.Backoff.html">../../crossbeam_utils/struct.Backoff.html</a>...</p>
<script>location.replace("../../crossbeam_utils/struct.Backoff.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../crossbeam_utils/struct.CachePadded.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../crossbeam_utils/struct.CachePadded.html">../../crossbeam_utils/struct.CachePadded.html</a>...</p>
<script>location.replace("../../crossbeam_utils/struct.CachePadded.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,19 @@
<!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="Miscellaneous tools for concurrent programming."><title>crossbeam_utils - 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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</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="#atomics" title="Atomics">Atomics</a></li><li><a href="#thread-synchronization" title="Thread synchronization">Thread synchronization</a></li><li><a href="#utilities" title="Utilities">Utilities</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</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>crossbeam_utils</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/crossbeam_utils/lib.rs.html#1-110">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Miscellaneous tools for concurrent programming.</p>
<h3 id="atomics"><a class="doc-anchor" href="#atomics">§</a>Atomics</h3>
<ul>
<li><a href="atomic/struct.AtomicCell.html" title="struct crossbeam_utils::atomic::AtomicCell"><code>AtomicCell</code></a>, a thread-safe mutable memory location.</li>
<li><a href="atomic/trait.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume"><code>AtomicConsume</code></a>, for reading from primitive atomic types with “consume” ordering.</li>
</ul>
<h3 id="thread-synchronization"><a class="doc-anchor" href="#thread-synchronization">§</a>Thread synchronization</h3>
<ul>
<li><a href="sync/struct.Parker.html" title="struct crossbeam_utils::sync::Parker"><code>Parker</code></a>, a thread parking primitive.</li>
<li><a href="sync/struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock"><code>ShardedLock</code></a>, a sharded reader-writer lock with fast concurrent reads.</li>
<li><a href="sync/struct.WaitGroup.html" title="struct crossbeam_utils::sync::WaitGroup"><code>WaitGroup</code></a>, for synchronizing the beginning or end of some computation.</li>
</ul>
<h3 id="utilities"><a class="doc-anchor" href="#utilities">§</a>Utilities</h3>
<ul>
<li><a href="struct.Backoff.html" title="struct crossbeam_utils::Backoff"><code>Backoff</code></a>, for exponential backoff in spin loops.</li>
<li><a href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded"><code>CachePadded</code></a>, for padding and aligning a value to the length of a cache line.</li>
<li><a href="thread/fn.scope.html" title="fn crossbeam_utils::thread::scope"><code>scope</code></a>, for spawning threads that borrow local variables from the stack.</li>
</ul>
</div></details><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="atomic/index.html" title="mod crossbeam_utils::atomic">atomic</a></div><div class="desc docblock-short">Atomic types.</div></li><li><div class="item-name"><a class="mod" href="sync/index.html" title="mod crossbeam_utils::sync">sync</a></div><div class="desc docblock-short">Thread synchronization primitives.</div></li><li><div class="item-name"><a class="mod" href="thread/index.html" title="mod crossbeam_utils::thread">thread</a></div><div class="desc docblock-short">Threads that can borrow variables from the stack.</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.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></div><div class="desc docblock-short">Performs exponential backoff in spin loops.</div></li><li><div class="item-name"><a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">Cache<wbr>Padded</a></div><div class="desc docblock-short">Pads and aligns a value to the length of a cache line.</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"mod":["atomic","sync","thread"],"struct":["Backoff","CachePadded"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,7 @@
<!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="Thread synchronization primitives."><title>crossbeam_utils::sync - 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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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="../../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module sync</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate crossbeam_<wbr>utils</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">crossbeam_utils</a></span><h1>Module <span>sync</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/crossbeam_utils/sync/mod.rs.html#1-17">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Thread synchronization primitives.</p>
<ul>
<li><a href="struct.Parker.html" title="struct crossbeam_utils::sync::Parker"><code>Parker</code></a>, a thread parking primitive.</li>
<li><a href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock"><code>ShardedLock</code></a>, a sharded reader-writer lock with fast concurrent reads.</li>
<li><a href="struct.WaitGroup.html" title="struct crossbeam_utils::sync::WaitGroup"><code>WaitGroup</code></a>, for synchronizing the beginning or end of some computation.</li>
</ul>
</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.Parker.html" title="struct crossbeam_utils::sync::Parker">Parker</a></div><div class="desc docblock-short">A thread parking primitive.</div></li><li><div class="item-name"><a class="struct" href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock">Sharded<wbr>Lock</a></div><div class="desc docblock-short">A sharded reader-writer lock.</div></li><li><div class="item-name"><a class="struct" href="struct.ShardedLockReadGuard.html" title="struct crossbeam_utils::sync::ShardedLockReadGuard">Sharded<wbr>Lock<wbr>Read<wbr>Guard</a></div><div class="desc docblock-short">A guard used to release the shared read access of a <a href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock"><code>ShardedLock</code></a> when dropped.</div></li><li><div class="item-name"><a class="struct" href="struct.ShardedLockWriteGuard.html" title="struct crossbeam_utils::sync::ShardedLockWriteGuard">Sharded<wbr>Lock<wbr>Write<wbr>Guard</a></div><div class="desc docblock-short">A guard used to release the exclusive write access of a <a href="struct.ShardedLock.html" title="struct crossbeam_utils::sync::ShardedLock"><code>ShardedLock</code></a> when dropped.</div></li><li><div class="item-name"><a class="struct" href="struct.Unparker.html" title="struct crossbeam_utils::sync::Unparker">Unparker</a></div><div class="desc docblock-short">Unparks a thread parked by the associated <a href="struct.Parker.html" title="struct crossbeam_utils::sync::Parker"><code>Parker</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.WaitGroup.html" title="struct crossbeam_utils::sync::WaitGroup">Wait<wbr>Group</a></div><div class="desc docblock-short">Enables threads to synchronize the beginning or end of some computation.</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.Parker.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.Parker.html">../../../crossbeam_utils/sync/struct.Parker.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.Parker.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.Unparker.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.Unparker.html">../../../crossbeam_utils/sync/struct.Unparker.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.Unparker.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.ShardedLock.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.ShardedLock.html">../../../crossbeam_utils/sync/struct.ShardedLock.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.ShardedLock.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.ShardedLockReadGuard.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.ShardedLockReadGuard.html">../../../crossbeam_utils/sync/struct.ShardedLockReadGuard.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.ShardedLockReadGuard.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.ShardedLockWriteGuard.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.ShardedLockWriteGuard.html">../../../crossbeam_utils/sync/struct.ShardedLockWriteGuard.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.ShardedLockWriteGuard.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["Parker","ShardedLock","ShardedLockReadGuard","ShardedLockWriteGuard","Unparker","WaitGroup"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../crossbeam_utils/sync/struct.WaitGroup.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../crossbeam_utils/sync/struct.WaitGroup.html">../../../crossbeam_utils/sync/struct.WaitGroup.html</a>...</p>
<script>location.replace("../../../crossbeam_utils/sync/struct.WaitGroup.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,19 @@
<!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="Creates a new scope for spawning threads."><title>scope in crossbeam_utils::thread - 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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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="../../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">scope</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In crossbeam_<wbr>utils::<wbr>thread</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">crossbeam_utils</a>::<wbr><a href="index.html">thread</a></span><h1>Function <span class="fn">scope</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/crossbeam_utils/thread.rs.html#153-210">Source</a> </span></div><pre class="rust item-decl"><code>pub fn scope&lt;'env, F, R&gt;(f: F) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.1/std/thread/type.Result.html" title="type std::thread::Result">Result</a>&lt;R&gt;<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;<a class="struct" href="struct.Scope.html" title="struct crossbeam_utils::thread::Scope">Scope</a>&lt;'env&gt;) -&gt; R,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new scope for spawning threads.</p>
<p>All child threads that havent been manually joined will be automatically joined just before
this function invocation ends. If all joined threads have successfully completed, <code>Ok</code> is
returned with the return value of <code>f</code>. If any of the joined threads has panicked, an <code>Err</code> is
returned containing errors from panicked threads. Note that if panics are implemented by
aborting the process, no error is returned; see the notes of <a href="https://doc.rust-lang.org/1.84.1/std/panic/fn.catch_unwind.html" title="fn std::panic::catch_unwind">std::panic::catch_unwind</a>.</p>
<p><strong>Note:</strong> Since Rust 1.63, this function is soft-deprecated in favor of the more efficient <a href="https://doc.rust-lang.org/1.84.1/std/thread/scoped/fn.scope.html" title="fn std::thread::scoped::scope"><code>std::thread::scope</code></a>.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::thread;
<span class="kw">let </span>var = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
thread::scope(|s| {
s.spawn(|<span class="kw">_</span>| {
<span class="macro">println!</span>(<span class="string">"A child thread borrowing `var`: {:?}"</span>, var);
});
}).unwrap();</code></pre></div>
</div></details></section></div></main></body></html>

View file

@ -0,0 +1,90 @@
<!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="Threads that can borrow variables from the stack."><title>crossbeam_utils::thread - 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="crossbeam_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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="../../crossbeam_utils/index.html">crossbeam_<wbr>utils</a><span class="version">0.8.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module thread</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#why-scoped-threads" title="Why scoped threads?">Why scoped threads?</a></li><li><a href="#how-scoped-threads-work" title="How scoped threads work">How scoped threads work</a></li><li><a href="#nesting-scoped-threads" title="Nesting scoped threads">Nesting scoped threads</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate crossbeam_<wbr>utils</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">crossbeam_utils</a></span><h1>Module <span>thread</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/crossbeam_utils/thread.rs.html#1-611">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Threads that can borrow variables from the stack.</p>
<p>Create a scope when spawned threads need to access variables on the stack:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::thread;
<span class="kw">let </span>people = <span class="macro">vec!</span>[
<span class="string">"Alice"</span>.to_string(),
<span class="string">"Bob"</span>.to_string(),
<span class="string">"Carol"</span>.to_string(),
];
thread::scope(|s| {
<span class="kw">for </span>person <span class="kw">in </span><span class="kw-2">&amp;</span>people {
s.spawn(<span class="kw">move </span>|<span class="kw">_</span>| {
<span class="macro">println!</span>(<span class="string">"Hello, {}!"</span>, person);
});
}
}).unwrap();</code></pre></div>
<h2 id="why-scoped-threads"><a class="doc-anchor" href="#why-scoped-threads">§</a>Why scoped threads?</h2>
<p>Suppose we wanted to re-write the previous example using plain threads:</p>
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile"></a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::thread;
<span class="kw">let </span>people = <span class="macro">vec!</span>[
<span class="string">"Alice"</span>.to_string(),
<span class="string">"Bob"</span>.to_string(),
<span class="string">"Carol"</span>.to_string(),
];
<span class="kw">let </span><span class="kw-2">mut </span>threads = Vec::new();
<span class="kw">for </span>person <span class="kw">in </span><span class="kw-2">&amp;</span>people {
threads.push(thread::spawn(<span class="kw">move </span>|| {
<span class="macro">println!</span>(<span class="string">"Hello, {}!"</span>, person);
}));
}
<span class="kw">for </span>thread <span class="kw">in </span>threads {
thread.join().unwrap();
}</code></pre></div>
<p>This doesnt work because the borrow checker complains about <code>people</code> not living long enough:</p>
<div class="example-wrap"><pre class="language-text"><code>error[E0597]: `people` does not live long enough
--&gt; src/main.rs:12:20
|
12 | for person in &amp;people {
| ^^^^^^ borrowed value does not live long enough
...
21 | }
| - borrowed value only lives until here
|
= note: borrowed value must be valid for the static lifetime...</code></pre></div>
<p>The problem here is that spawned threads are not allowed to borrow variables on stack because
the compiler cannot prove they will be joined before <code>people</code> is destroyed.</p>
<p>Scoped threads are a mechanism to guarantee to the compiler that spawned threads will be joined
before the scope ends.</p>
<h2 id="how-scoped-threads-work"><a class="doc-anchor" href="#how-scoped-threads-work">§</a>How scoped threads work</h2>
<p>If a variable is borrowed by a thread, the thread must complete before the variable is
destroyed. Threads spawned using <a href="https://doc.rust-lang.org/1.84.1/std/thread/fn.spawn.html" title="fn std::thread::spawn"><code>std::thread::spawn</code></a> can only borrow variables with the
<code>'static</code> lifetime because the borrow checker cannot be sure when the thread will complete.</p>
<p>A scope creates a clear boundary between variables outside the scope and threads inside the
scope. Whenever a scope spawns a thread, it promises to join the thread before the scope ends.
This way we guarantee to the borrow checker that scoped threads only live within the scope and
can safely access variables outside it.</p>
<h2 id="nesting-scoped-threads"><a class="doc-anchor" href="#nesting-scoped-threads">§</a>Nesting scoped threads</h2>
<p>Sometimes scoped threads need to spawn more threads within the same scope. This is a little
tricky because argument <code>s</code> lives <em>inside</em> the invocation of <code>thread::scope()</code> and as such
cannot be borrowed by scoped threads:</p>
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile"></a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::thread;
thread::scope(|s| {
s.spawn(|<span class="kw">_</span>| {
<span class="comment">// Not going to compile because we're trying to borrow `s`,
// which lives *inside* the scope! :(
</span>s.spawn(|<span class="kw">_</span>| <span class="macro">println!</span>(<span class="string">"nested thread"</span>));
});
});</code></pre></div>
<p>Fortunately, there is a solution. Every scoped thread is passed a reference to its scope as an
argument, which can be used for spawning nested threads:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::thread;
thread::scope(|s| {
<span class="comment">// Note the `|s|` here.
</span>s.spawn(|s| {
<span class="comment">// Yay, this works because we're using a fresh argument `s`! :)
</span>s.spawn(|<span class="kw">_</span>| <span class="macro">println!</span>(<span class="string">"nested thread"</span>));
});
}).unwrap();</code></pre></div>
</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.Scope.html" title="struct crossbeam_utils::thread::Scope">Scope</a></div><div class="desc docblock-short">A scope for spawning threads.</div></li><li><div class="item-name"><a class="struct" href="struct.ScopedJoinHandle.html" title="struct crossbeam_utils::thread::ScopedJoinHandle">Scoped<wbr>Join<wbr>Handle</a></div><div class="desc docblock-short">A handle that can be used to join its scoped thread.</div></li><li><div class="item-name"><a class="struct" href="struct.ScopedThreadBuilder.html" title="struct crossbeam_utils::thread::ScopedThreadBuilder">Scoped<wbr>Thread<wbr>Builder</a></div><div class="desc docblock-short">Configures the properties of a new thread.</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.scope.html" title="fn crossbeam_utils::thread::scope">scope</a></div><div class="desc docblock-short">Creates a new scope for spawning threads.</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["scope"],"struct":["Scope","ScopedJoinHandle","ScopedThreadBuilder"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long