<!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="API documentation for the Rust `thread` mod in crate `alacritty`."><meta name="keywords" content="rust, rustlang, rust-lang, thread"><title>alacritty::util::thread - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../alacritty/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Module thread</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a></p><script>window.sidebarCurrent = {name: 'thread', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/alacritty/util.rs.html#28-41' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a>::<wbr><a class="mod" href=''>thread</a></span></h1><div class='docblock'><p>Threading utilities</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.AccessError.html" title='alacritty::util::thread::AccessError struct'>AccessError</a></td><td class='docblock-short'><p>An error returned by <a href="struct.LocalKey.html#method.try_with"><code>LocalKey::try_with</code></a>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Builder.html" title='alacritty::util::thread::Builder struct'>Builder</a></td><td class='docblock-short'><p>Thread factory, which can be used in order to configure the properties of
a new thread.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.JoinHandle.html" title='alacritty::util::thread::JoinHandle struct'>JoinHandle</a></td><td class='docblock-short'><p>An owned permission to join on a thread (block on its termination).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LocalKey.html" title='alacritty::util::thread::LocalKey struct'>LocalKey</a></td><td class='docblock-short'><p>A thread local storage key which owns its contents.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Thread.html" title='alacritty::util::thread::Thread struct'>Thread</a></td><td class='docblock-short'><p>A handle to a thread.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ThreadId.html" title='alacritty::util::thread::ThreadId struct'>ThreadId</a></td><td class='docblock-short'><p>A unique identifier for a running thread.</p>
</td></tr><tr class='unstable module-item'><td><a class="struct" href="struct.__FastLocalKeyInner.html" title='alacritty::util::thread::__FastLocalKeyInner struct'>__FastLocalKeyInner</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span></td></tr><tr class='unstable module-item'><td><a class="struct" href="struct.__OsLocalKeyInner.html" title='alacritty::util::thread::__OsLocalKeyInner struct'>__OsLocalKeyInner</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.current.html" title='alacritty::util::thread::current fn'>current</a></td><td class='docblock-short'><p>Gets a handle to the thread that invokes it.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.panicking.html" title='alacritty::util::thread::panicking fn'>panicking</a></td><td class='docblock-short'><p>Determines whether the current thread is unwinding because of panic.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.park.html" title='alacritty::util::thread::park fn'>park</a></td><td class='docblock-short'><p>Blocks unless or until the current thread's token is made available.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.park_timeout.html" title='alacritty::util::thread::park_timeout fn'>park_timeout</a></td><td class='docblock-short'><p>Blocks unless or until the current thread's token is made available or
the specified duration has been reached (may wake spuriously).</p>
</td></tr><tr class='deprecated module-item'><td><a class="fn" href="fn.park_timeout_ms.html" title='alacritty::util::thread::park_timeout_ms fn'>park_timeout_ms</a></td><td class='docblock-short'><span class="stab deprecated">Deprecated</span><p>Use <a href="fn.park_timeout.html"><code>park_timeout</code></a>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sleep.html" title='alacritty::util::thread::sleep fn'>sleep</a></td><td class='docblock-short'><p>Puts the current thread to sleep for at least the specified amount of time.</p>
</td></tr><tr class='deprecated module-item'><td><a class="fn" href="fn.sleep_ms.html" title='alacritty::util::thread::sleep_ms fn'>sleep_ms</a></td><td class='docblock-short'><span class="stab deprecated">Deprecated</span><p>Puts the current thread to sleep for at least the specified amount of time.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spawn.html" title='alacritty::util::thread::spawn fn'>spawn</a></td><td class='docblock-short'><p>Spawns a new thread, returning a <a href="../../std/thread/struct.JoinHandle.html"><code>JoinHandle</code></a> for it.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spawn_named.html" title='alacritty::util::thread::spawn_named fn'>spawn_named</a></td><td class='docblock-short'><p>Like <code>thread::spawn</code>, but with a <code>name</code> argument</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.yield_now.html" title='alacritty::util::thread::yield_now fn'>yield_now</a></td><td class='docblock-short'><p>Cooperatively gives up a timeslice to the OS scheduler.</p>
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='alacritty::util::thread::Result type'>Result</a></td><td class='docblock-short'><p>A specialized <a href="../../std/result/enum.Result.html"><code>Result</code></a> type for threads.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "alacritty";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
