mentat/tokio_threadpool/park/struct.DefaultPark.html
2018-08-22 17:04:13 +00:00

153 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 `DefaultPark` struct in crate `tokio_threadpool`.">
<meta name="keywords" content="rust, rustlang, rust-lang, DefaultPark">
<title>tokio_threadpool::park::DefaultPark - 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 struct">
<!--[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'>Struct DefaultPark</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Park">Park</a></div></div><p class='location'><a href='../index.html'>tokio_threadpool</a>::<wbr><a href='index.html'>park</a></p><script>window.sidebarCurrent = {name: 'DefaultPark', ty: 'struct', 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'>Struct <a href='../index.html'>tokio_threadpool</a>::<wbr><a href='index.html'>park</a>::<wbr><a class="struct" href=''>DefaultPark</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_threadpool/park/default_park.rs.html#12-14' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct DefaultPark { /* fields omitted */ }</pre><div class='docblock'><p>Parks the thread.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../tokio_threadpool/park/struct.DefaultPark.html" title="struct tokio_threadpool::park::DefaultPark">DefaultPark</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#45-67' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../tokio_threadpool/park/struct.DefaultPark.html" title="struct tokio_threadpool::park::DefaultPark">DefaultPark</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#47-55' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Creates a new <code>DefaultPark</code> instance.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tokio_threadpool/park/struct.DefaultPark.html" title="struct tokio_threadpool::park::DefaultPark">DefaultPark</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#11' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#11' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Park' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../tokio_executor/park/trait.Park.html" title="trait tokio_executor::park::Park">Park</a> for <a class="struct" href="../../tokio_threadpool/park/struct.DefaultPark.html" title="struct tokio_threadpool::park::DefaultPark">DefaultPark</a></code><a href='#impl-Park' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#69-87' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Unpark' class="type"><span id='Unpark.t' class='invisible'><code>type <a href='../../tokio_executor/park/trait.Park.html#associatedtype.Unpark' class="type">Unpark</a> = <a class="struct" href="../../tokio_threadpool/park/struct.DefaultUnpark.html" title="struct tokio_threadpool::park::DefaultUnpark">DefaultUnpark</a></code></span></h4>
<div class='docblock'><p>Unpark handle type for the <code>Park</code> implementation.</p>
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../tokio_executor/park/trait.Park.html#associatedtype.Error' class="type">Error</a> = <a class="struct" href="../../tokio_threadpool/park/struct.ParkError.html" title="struct tokio_threadpool::park::ParkError">ParkError</a></code></span></h4>
<div class='docblock'><p>Error returned by <code>park</code></p>
</div><h4 id='method.unpark' class="method"><span id='unpark.v' class='invisible'><code>fn <a href='../../tokio_executor/park/trait.Park.html#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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#73-76' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Get a new <code>Unpark</code> handle associated with this <code>Park</code> instance.</p>
</div><h4 id='method.park' class="method"><span id='park.v' class='invisible'><code>fn <a href='../../tokio_executor/park/trait.Park.html#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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#78-81' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Block the current thread unless or until the token is available. <a href="../../tokio_executor/park/trait.Park.html#tymethod.park">Read more</a></p>
</div><h4 id='method.park_timeout' class="method"><span id='park_timeout.v' class='invisible'><code>fn <a href='../../tokio_executor/park/trait.Park.html#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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_threadpool/park/default_park.rs.html#83-86' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Park the current thread for at most <code>duration</code>. <a href="../../tokio_executor/park/trait.Park.html#tymethod.park_timeout">Read more</a></p>
</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>&#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_threadpool";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>