mentat/want/struct.Giver.html
2018-08-22 17:04:13 +00:00

162 lines
No EOL
11 KiB
HTML
Raw Permalink 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 `Giver` struct in crate `want`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Giver">
<title>want::Giver - 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 Giver</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.poll_want">poll_want</a><a href="#method.give">give</a><a href="#method.is_wanting">is_wanting</a><a href="#method.is_canceled">is_canceled</a><a href="#method.shared">shared</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>want</a></p><script>window.sidebarCurrent = {name: 'Giver', 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'>want</a>::<wbr><a class="struct" href=''>Giver</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/want/lib.rs.html#55-57' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Giver { /* fields omitted */ }</pre><div class='docblock'><p>An entity that gives a value when wanted.</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="../want/struct.Giver.html" title="struct want::Giver">Giver</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#116-214' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.poll_want' class="method"><span id='poll_want.v' class='invisible'><code>pub fn <a href='#method.poll_want' class='fnname'>poll_want</a>(&amp;mut self) -&gt; <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../want/struct.Closed.html" title="struct want::Closed">Closed</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#127-176' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Poll whether the <code>Taker</code> has registered interest in another value.</p>
<ul>
<li>If the <code>Taker</code> has called <code>want()</code>, this returns <code>Async::Ready(())</code>.</li>
<li>If the <code>Taker</code> has not called <code>want()</code> since last poll, this
returns <code>Async::NotReady</code>, and parks the current task to be notified
when the <code>Taker</code> does call <code>want()</code>.</li>
<li>If the <code>Taker</code> has canceled (or dropped), this returns <code>Closed</code>.</li>
</ul>
<p>After knowing that the Taker is wanting, the state can be reset by
calling <a href="Giver::give"><code>give</code></a>.</p>
</div><h4 id='method.give' class="method"><span id='give.v' class='invisible'><code>pub fn <a href='#method.give' class='fnname'>give</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#182-189' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Mark the state as idle, if the Taker currently is wanting.</p>
<p>Returns true if Taker was wanting, false otherwise.</p>
</div><h4 id='method.is_wanting' class="method"><span id='is_wanting.v' class='invisible'><code>pub fn <a href='#method.is_wanting' class='fnname'>is_wanting</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#196-198' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Check if the <code>Taker</code> has called <code>want()</code> without parking a task.</p>
<p>This is safe to call outside of a futures task context, but other
means of being notified is left to the user.</p>
</div><h4 id='method.is_canceled' class="method"><span id='is_canceled.v' class='invisible'><code>pub fn <a href='#method.is_canceled' class='fnname'>is_canceled</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#203-205' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Check if the <code>Taker</code> has canceled interest without parking a task.</p>
</div><h4 id='method.shared' class="method"><span id='shared.v' class='invisible'><code>pub fn <a href='#method.shared' class='fnname'>shared</a>(self) -&gt; <a class="struct" href="../want/struct.SharedGiver.html" title="struct want::SharedGiver">SharedGiver</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#209-213' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Converts this into a <code>SharedGiver</code>.</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="../want/struct.Giver.html" title="struct want::Giver">Giver</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/want/lib.rs.html#216-222' 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, f: &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/want/lib.rs.html#217-221' 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></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 = "want";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>