github-actions[bot]
26 lines
6.4 KiB
HTML
26 lines
6.4 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="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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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 rust-logo'><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><div id="sidebar-vars" data-name="park" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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="in-band">Function <a href="index.html">parking_lot_core</a>::<wbr><a class="fn" href="">park</a></span><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#567-682" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub unsafe fn park(<br> key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> validate: impl <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> before_sleep: impl <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> timed_out: impl <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>), <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="type" href="../instant/native/type.Instant.html" title="type instant::native::Instant">Instant</a>><br>) -> <a class="enum" href="../parking_lot_core/enum.ParkResult.html" title="enum parking_lot_core::ParkResult">ParkResult</a></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><div id="rustdoc-vars" data-root-path="../" data-current-crate="parking_lot_core"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |