yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/solicit/http/frame/settings/enum.HttpSetting.html

150 lines
13 KiB
HTML
Raw Normal View History

Update documentation for Juniper
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 `HttpSetting` enum in crate `solicit`.">
<meta name="keywords" content="rust, rustlang, rust-lang, HttpSetting">
<title>solicit::http::frame::settings::HttpSetting - 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'>frame</a>::<wbr><a href='index.html'>settings</a></p><script>window.sidebarCurrent = {name: 'HttpSetting', ty: 'enum', 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 enum">
<h1 class='fqn'><span class='in-band'>Enum <a href='../../../index.html'>solicit</a>::<wbr><a href='../../index.html'>http</a>::<wbr><a href='../index.html'>frame</a>::<wbr><a href='index.html'>settings</a>::<wbr><a class='enum' href=''>HttpSetting</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-387' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#20-27' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum HttpSetting {
HeaderTableSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
EnablePush(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
MaxConcurrentStreams(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
InitialWindowSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
MaxFrameSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
MaxHeaderListSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>),
}</pre><div class='docblock'><p>An enum that lists all valid settings that can be sent in a SETTINGS
frame.</p>
<p>Each setting has a value that is a 32 bit unsigned integer (6.5.1.).</p>
</div><h2 class='variants'>Variants</h2>
<span id='variant.HeaderTableSize' class='variant'><code>HeaderTableSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><span id='variant.EnablePush' class='variant'><code>EnablePush(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><span id='variant.MaxConcurrentStreams' class='variant'><code>MaxConcurrentStreams(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><span id='variant.InitialWindowSize' class='variant'><code>InitialWindowSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><span id='variant.MaxFrameSize' class='variant'><code>MaxFrameSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><span id='variant.MaxHeaderListSize' class='variant'><code>MaxHeaderListSize(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>)</code></span><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-400' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#29-100' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from_id' class='method'><code>fn <a href='#method.from_id' class='fnname'>from_id</a>(id: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a>, val: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;<a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a>&gt;</code></h4>
<div class='docblock'><p>Creates a new <code>HttpSetting</code> with the correct variant corresponding to
the given setting id, based on the settings IDs defined in section
6.5.2.</p>
</div><h4 id='method.get_id' class='method'><code>fn <a href='#method.get_id' class='fnname'>get_id</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a></code></h4>
<div class='docblock'><p>Returns the setting ID as an unsigned 16 bit integer, as defined in
section 6.5.2.</p>
</div><h4 id='method.get_val' class='method'><code>fn <a href='#method.get_val' class='fnname'>get_val</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a></code></h4>
<div class='docblock'><p>Gets the setting value by unpacking it from the wrapped <code>u32</code>.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-326' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#16' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-335' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#17' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-370' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#18' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class='method'><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='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='enum' href='../../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-386' class='srclink' href='../../../../src/solicit/http/frame/settings.rs.html#19' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></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>
Reference in a new issue Copy permalink