juniper/solicit/http/priority/struct.SimplePrioritizer.html

128 lines
8 KiB
HTML
Raw Normal View History

2016-09-11 13:41:24 -05:00
<!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 `SimplePrioritizer` struct in crate `solicit`.">
<meta name="keywords" content="rust, rustlang, rust-lang, SimplePrioritizer">
<title>solicit::http::priority::SimplePrioritizer - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>priority</a></p><script>window.sidebarCurrent = {name: 'SimplePrioritizer', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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 struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>priority</a>::<wbr><a class='struct' href=''>SimplePrioritizer</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 id='src-1211' class='srclink' href='../../../src/solicit/http/priority.rs.html#31-36' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct SimplePrioritizer&lt;'a,&nbsp;'b,&nbsp;State&gt; <span class='where'>where State: <a class='trait' href='../../../solicit/http/session/trait.SessionState.html' title='solicit::http::session::SessionState'>SessionState</a> + 'a</span> {
// some fields omitted
}</pre><div class='docblock'><p>An implementation of the <code>DataPrioritizer</code> trait that is based on finding the first stream from
the given <code>SessionState</code> instance that can send data and returning this chunk.</p>
<p>For all means and purposes, the order of data chunks that the prioritizer returns is undefined
and should not be relied on.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a,&nbsp;'b,&nbsp;State&gt; <a class='struct' href='../../../solicit/http/priority/struct.SimplePrioritizer.html' title='solicit::http::priority::SimplePrioritizer'>SimplePrioritizer</a>&lt;'a,&nbsp;'b,&nbsp;State&gt; <span class='where'>where State: <a class='trait' href='../../../solicit/http/session/trait.SessionState.html' title='solicit::http::session::SessionState'>SessionState</a> + 'a</span></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1217' class='srclink' href='../../../src/solicit/http/priority.rs.html#38-47' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(state: &amp;'a mut State, buf: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'b mut [</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -&gt; <a class='struct' href='../../../solicit/http/priority/struct.SimplePrioritizer.html' title='solicit::http::priority::SimplePrioritizer'>SimplePrioritizer</a>&lt;'a,&nbsp;'b,&nbsp;State&gt;</code></h4>
<div class='docblock'><p>Creates a new <code>SimplePrioritizer</code> that will use the given state to find stream data that
should be sent and use the given buffer to hold the data of the returned chunk.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a,&nbsp;'b,&nbsp;State&gt; <a class='trait' href='../../../solicit/http/priority/trait.DataPrioritizer.html' title='solicit::http::priority::DataPrioritizer'>DataPrioritizer</a> for <a class='struct' href='../../../solicit/http/priority/struct.SimplePrioritizer.html' title='solicit::http::priority::SimplePrioritizer'>SimplePrioritizer</a>&lt;'a,&nbsp;'b,&nbsp;State&gt; <span class='where'>where State: <a class='trait' href='../../../solicit/http/session/trait.SessionState.html' title='solicit::http::session::SessionState'>SessionState</a> + 'a</span></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1224' class='srclink' href='../../../src/solicit/http/priority.rs.html#49-83' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.get_next_chunk' class='method'><code>fn <a href='../../../solicit/http/priority/trait.DataPrioritizer.html#tymethod.get_next_chunk' class='fnname'>get_next_chunk</a>(&amp;mut self) -&gt; <a class='type' href='../../../solicit/http/type.HttpResult.html' title='solicit::http::HttpResult'>HttpResult</a>&lt;<a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;<a class='struct' href='../../../solicit/http/connection/struct.DataChunk.html' title='solicit::http::connection::DataChunk'>DataChunk</a>&gt;&gt;</code></h4>
<div class='docblock'><p>Returns the next <code>DataChunk</code> that should be sent on the HTTP/2 connection. <code>None</code> indicates that currently there was no data that could be sent at that point. <a href="../../../solicit/http/priority/trait.DataPrioritizer.html#tymethod.get_next_chunk">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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "solicit";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>