29 lines
6.1 KiB
HTML
29 lines
6.1 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="Parks the current thread in the queue associated with the given key."><title>park in parking_lot_core - 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"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="parking_lot_core" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">park</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../parking_lot_core/index.html">parking_<wbr>lot_<wbr>core</a><span class="version">0.9.12</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">park</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate parking_<wbr>lot_<wbr>core</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">parking_lot_core</a></div><h1>Function <span class="fn">park</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/parking_lot_core/parking_lot.rs.html#591-706">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn park(
|
|
key: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>,
|
|
validate: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>,
|
|
before_sleep: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(),
|
|
timed_out: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>),
|
|
park_token: <a class="struct" href="struct.ParkToken.html" title="struct parking_lot_core::ParkToken">ParkToken</a>,
|
|
timeout: <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>>,
|
|
) -> <a class="enum" href="enum.ParkResult.html" title="enum parking_lot_core::ParkResult">ParkResult</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|
<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></details></section></div></main></body></html> |