|
|
<!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` fn in crate `parking_lot_core`."><meta name="keywords" content="rust, rustlang, rust-lang, park"><title>parking_lot_core::park - 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='../parking_lot_core/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>parking_lot_core</a></p><script>window.sidebarCurrent = {name: 'park', 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 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/parking_lot_core/parking_lot.rs.html#538-562' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>parking_lot_core</a>::<wbr><a class="fn" href=''>park</a></span></h1><pre class='rust fn'>pub unsafe fn park<V, B, T>(<br> key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> validate: V, <br> before_sleep: B, <br> timed_out: T, <br> park_token: <a class="struct" href="../parking_lot_core/struct.ParkToken.html" title="struct parking_lot_core::ParkToken">ParkToken</a>, <br> timeout: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>><br>) -> <a class="enum" href="../parking_lot_core/enum.ParkResult.html" title="enum parking_lot_core::ParkResult">ParkResult</a> <span class="where fmt-newline">where<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(),<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>), </span></pre><div class='docblock'><p>Parks the current thread in the queue associated with the given key.</p>
|
|
|
<p>The <code>validate</code> function is called while the queue is locked and can abort
|
|
|
the operation by returning false. If <code>validate</code> returns true then the
|
|
|
current thread is appended to the queue and the queue is unlocked.</p>
|
|
|
<p>The <code>before_sleep</code> function is called after the queue is unlocked but before
|
|
|
the thread is put to sleep. The thread will then sleep until it is unparked
|
|
|
or the given timeout is reached.</p>
|
|
|
<p>The <code>timed_out</code> function is also called while the queue is locked, but only
|
|
|
if the timeout was reached. It is passed the key of the queue it was in when
|
|
|
it timed out, which may be different from the original key if
|
|
|
<code>unpark_requeue</code> was called. It is also passed a bool which indicates
|
|
|
whether it was the last thread in the queue.</p>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<p>You should only call this function with an address that you control, since
|
|
|
you could otherwise interfere with the operation of other synchronization
|
|
|
primitives.</p>
|
|
|
<p>The <code>validate</code> and <code>timed_out</code> functions are called while the queue is
|
|
|
locked and must not panic or call into any function in <code>parking_lot</code>.</p>
|
|
|
<p>The <code>before_sleep</code> function is called outside the queue lock and is allowed
|
|
|
to call <code>unpark_one</code>, <code>unpark_all</code>, <code>unpark_requeue</code> or <code>unpark_filter</code>, but
|
|
|
it is not allowed to call <code>park</code> or panic.</p>
|
|
|
</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 = "parking_lot_core";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
