mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-09-07 02:50:36 +00:00
14 lines
No EOL
5.2 KiB
HTML
14 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="A utility module for working with threads that automatically joins threads upon drop and abstracts over operating system quality of service (`QoS`) APIs through the concept of a “thread intent”."><title>stdx::thread - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="stdx" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.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="../../stdx/index.html">stdx</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module thread</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="#enums" title="Enums">Enums</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 stdx</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">stdx</a></div><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/stdx/thread.rs.html#1-109">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A utility module for working with threads that automatically joins threads upon drop
|
|
and abstracts over operating system quality of service (<code>QoS</code>) APIs
|
|
through the concept of a “thread intent”.</p>
|
|
<p>The intent of a thread is frozen at thread creation time,
|
|
i.e. there is no API to change the intent of a thread once it has been spawned.</p>
|
|
<p>As a system, rust-analyzer should have the property that
|
|
old manual scheduling APIs are replaced entirely by <code>QoS</code>.
|
|
To maintain this invariant, we panic when it is clear that
|
|
old scheduling APIs have been used.</p>
|
|
<p>Moreover, we also want to ensure that every thread has an intent set explicitly
|
|
to force a decision about its importance to the system.
|
|
Thus, <a href="enum.ThreadIntent.html" title="enum stdx::thread::ThreadIntent"><code>ThreadIntent</code></a> has no default value
|
|
and every entry point to creating a thread requires a <a href="enum.ThreadIntent.html" title="enum stdx::thread::ThreadIntent"><code>ThreadIntent</code></a> upfront.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Builder.html" title="struct stdx::thread::Builder">Builder</a></dt><dt><a class="struct" href="struct.JoinHandle.html" title="struct stdx::thread::JoinHandle">Join<wbr>Handle</a></dt><dt><a class="struct" href="struct.Pool.html" title="struct stdx::thread::Pool">Pool</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ThreadIntent.html" title="enum stdx::thread::ThreadIntent">Thread<wbr>Intent</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.spawn.html" title="fn stdx::thread::spawn">spawn</a></dt><dd>Panics</dd></dl></section></div></main></body></html> |