mentat/tokio_executor/park/trait.Park.html
2018-08-22 17:04:13 +00:00

176 lines
No EOL
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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` trait in crate `tokio_executor`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Park">
<title>tokio_executor::park::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="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc trait">
<!--[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">&#9776;</div>
<p class='location'>Trait Park</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Unpark">Unpark</a><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.unpark">unpark</a><a href="#tymethod.park">park</a><a href="#tymethod.park_timeout">park_timeout</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>tokio_executor</a>::<wbr><a href='index.html'>park</a></p><script>window.sidebarCurrent = {name: 'Park', ty: 'trait', 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">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>tokio_executor</a>::<wbr><a href='index.html'>park</a>::<wbr><a class="trait" 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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/tokio_executor/park.rs.html#58-104' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Park {
type <a href='#associatedtype.Unpark' class="type">Unpark</a>: <a class="trait" href="../../tokio_executor/park/trait.Unpark.html" title="trait tokio_executor::park::Unpark">Unpark</a>;
type <a href='#associatedtype.Error' class="type">Error</a>;
fn <a href='#tymethod.unpark' class='fnname'>unpark</a>(&amp;self) -&gt; Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Unpark" title="type tokio_executor::park::Park::Unpark">Unpark</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.park' class='fnname'>park</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Error" title="type tokio_executor::park::Park::Error">Error</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.park_timeout' class='fnname'>park_timeout</a>(&amp;mut self, duration: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Error" title="type tokio_executor::park::Park::Error">Error</a>&gt;;
}</pre><div class='docblock'><p>Block the current thread.</p>
<p>See <a href="../index.html">module documentation</a> for more details.</p>
</div>
<h2 id='associated-types' class='small-section-header'>
Associated Types<a href='#associated-types' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='associatedtype.Unpark' class='method'><span id='Unpark.t' class='invisible'><code>type <a href='#associatedtype.Unpark' class="type">Unpark</a>: <a class="trait" href="../../tokio_executor/park/trait.Unpark.html" title="trait tokio_executor::park::Unpark">Unpark</a></code></span></h3><div class='docblock'><p>Unpark handle type for the <code>Park</code> implementation.</p>
</div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>Error returned by <code>park</code></p>
</div></div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.unpark' class='method'><span id='unpark.v' class='invisible'><code>fn <a href='#tymethod.unpark' class='fnname'>unpark</a>(&amp;self) -&gt; Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Unpark" title="type tokio_executor::park::Park::Unpark">Unpark</a></code></span></h3><div class='docblock'><p>Get a new <code>Unpark</code> handle associated with this <code>Park</code> instance.</p>
</div><h3 id='tymethod.park' class='method'><span id='park.v' class='invisible'><code>fn <a href='#tymethod.park' class='fnname'>park</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Error" title="type tokio_executor::park::Park::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Block the current thread unless or until the token is available.</p>
<p>A call to <code>park</code> does not guarantee that the thread will remain blocked
forever, and callers should be prepared for this possibility. This
function may wakeup spuriously for any reason.</p>
<p>See <a href="../index.html">module documentation</a> for more details.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>This function <strong>should</strong> not panic, but ultimately, panics are left as
an implementation detail. Refer to the documentation for the specific
<code>Park</code> implementation</p>
</div><h3 id='tymethod.park_timeout' class='method'><span id='park_timeout.v' class='invisible'><code>fn <a href='#tymethod.park_timeout' class='fnname'>park_timeout</a>(&amp;mut self, duration: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_executor/park/trait.Park.html#associatedtype.Error" title="type tokio_executor::park::Park::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Park the current thread for at most <code>duration</code>.</p>
<p>This function is the same as <code>park</code> but allows specifying a maximum time
to block the thread for.</p>
<p>Same as <code>park</code>, there is no guarantee that the thread will remain
blocked for any amount of time. Spurious wakeups are permitted for any
reason.</p>
<p>See <a href="../index.html">module documentation</a> for more details.</p>
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
<p>This function <strong>should</strong> not panic, but ultimately, panics are left as
an implementation detail. Refer to the documentation for the specific
<code>Park</code> implementation</p>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../../src/tokio_executor/park.rs.html#207-223' title='goto source code'>[src]</a></div><code>impl Park for <a class="struct" href="../../tokio_executor/park/struct.ParkThread.html" title="struct tokio_executor::park::ParkThread">ParkThread</a><span class="where fmt-newline"> type <a href='#associatedtype.Unpark' class="type">Unpark</a> = <a class="struct" href="../../tokio_executor/park/struct.UnparkThread.html" title="struct tokio_executor::park::UnparkThread">UnparkThread</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = <a class="struct" href="../../tokio_executor/park/struct.ParkError.html" title="struct tokio_executor::park::ParkError">ParkError</a>;</span></code></li>
</ul><script type="text/javascript" async
src="../../implementors/tokio_executor/park/trait.Park.js">
</script></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>&#9166;</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "tokio_executor";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>