<!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 `park_timeout` fn in crate `alacritty`."><meta name="keywords" content="rust, rustlang, rust-lang, park_timeout"><title>alacritty::util::thread::park_timeout - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a>::<wbr><a href='index.html'>thread</a></p><script>window.sidebarCurrent = {name: 'park_timeout', ty: 'fn', 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 class='since' title='Stable since Rust version 1.4.0'>1.4.0</span><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='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#978-1009' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a>::<wbr><a href='index.html'>thread</a>::<wbr><a class="fn" href=''>park_timeout</a></span></h1><pre class='rust fn'>pub fn park_timeout(dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>)</pre><div class='docblock'><p>Blocks unless or until the current thread's token is made available or
the specified duration has been reached (may wake spuriously).</p>
<p>The semantics of this function are equivalent to <a href="fn.park.html"><code>park</code></a> except
that the thread will be blocked for roughly no longer than <code>dur</code>. This
method should not be used for precise timing due to anomalies such as
preemption or platform differences that may not cause the maximum
amount of time waited to be precisely <code>dur</code> long.</p>
<p>See the <a href="fn.park.html">park documentation</a> for more details.</p>
<h1 id="platform-specific-behavior" class="section-header"><a href="#platform-specific-behavior">Platform-specific behavior</a></h1>
<p>Platforms which do not support nanosecond precision for sleeping will have
<code>dur</code> rounded up to the nearest granularity of time they can sleep for.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>Waiting for the complete expiration of the timeout:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>::<span class="ident">park_timeout</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::{<span class="ident">Instant</span>, <span class="ident">Duration</span>};
<span class="kw">let</span> <span class="ident">timeout</span> <span class="op">=</span> <span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">2</span>);
<span class="kw">let</span> <span class="ident">beginning_park</span> <span class="op">=</span> <span class="ident">Instant</span>::<span class="ident">now</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">timeout_remaining</span> <span class="op">=</span> <span class="ident">timeout</span>;
<span class="kw">loop</span> {
<span class="ident">park_timeout</span>(<span class="ident">timeout_remaining</span>);
<span class="kw">let</span> <span class="ident">elapsed</span> <span class="op">=</span> <span class="ident">beginning_park</span>.<span class="ident">elapsed</span>();
<span class="kw">if</span> <span class="ident">elapsed</span> <span class="op">>=</span> <span class="ident">timeout</span> {
<span class="kw">break</span>;
}
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"restarting park_timeout after {:?}"</span>, <span class="ident">elapsed</span>);
<span class="ident">timeout_remaining</span> <span class="op">=</span> <span class="ident">timeout</span> <span class="op">-</span> <span class="ident">elapsed</span>;
}</pre></div>
</div></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>
