<!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 `StreamDependency` struct in crate `solicit`."> <meta name="keywords" content="rust, rustlang, rust-lang, StreamDependency"> <title>solicit::http::frame::headers::StreamDependency - 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'>headers</a></p><script>window.sidebarCurrent = {name: 'StreamDependency', 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'>frame</a>::<wbr><a href='index.html'>headers</a>::<wbr><a class='struct' href=''>StreamDependency</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'>−</span>] </a> </span><a id='src-200' class='srclink' href='../../../../src/solicit/http/frame/headers.rs.html#41-50' title='goto source code'>[src]</a></span></h1> <pre class='rust struct'>pub struct StreamDependency { pub stream_id: <a class='type' href='../../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>, pub weight: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>, pub is_exclusive: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>, }</pre><div class='docblock'><p>The struct represents the dependency information that can be attached to a stream and sent within a HEADERS frame (one with the Priority flag set).</p> </div><h2 class='fields'>Fields</h2><span id='structfield.stream_id' class='structfield'><code>stream_id: <a class='type' href='../../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a></code> </span><span class='stab '></span><div class='docblock'><p>The ID of the stream that a particular stream depends on</p> </div><span id='structfield.weight' class='structfield'><code>weight: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a></code> </span><span class='stab '></span><div class='docblock'><p>The weight for the stream. The value exposed (and set) here is always in the range [0, 255], instead of [1, 256] (as defined in section 5.3.2.) so that the value fits into a <code>u8</code>.</p> </div><span id='structfield.is_exclusive' class='structfield'><code>is_exclusive: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code> </span><span class='stab '></span><div class='docblock'><p>A flag indicating whether the stream dependency is exclusive.</p> </div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-204' class='srclink' href='../../../../src/solicit/http/frame/headers.rs.html#52-119' 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>(stream_id: <a class='type' href='../../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>, weight: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>, is_exclusive: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>) -> <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></h4> <div class='docblock'><p>Creates a new <code>StreamDependency</code> with the given stream ID, weight, and exclusivity.</p> </div><h4 id='method.parse' class='method'><code>fn <a href='#method.parse' class='fnname'>parse</a>(buf: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&[</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>) -> <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></h4> <div class='docblock'><p>Parses the first 5 bytes in the buffer as a <code>StreamDependency</code>. (Each 5-byte sequence is always decodable into a stream dependency structure).</p> <h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1> <p>If the given buffer has less than 5 elements, the method will panic.</p> </div><h4 id='method.serialize' class='method'><code>fn <a href='#method.serialize' class='fnname'>serialize</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.array.html'>[</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.array.html'>; 5]</a></code></h4> <div class='docblock'><p>Serializes the <code>StreamDependency</code> into a 5-byte buffer representing the dependency description, as described in section 6.2. of the HTTP/2 spec:</p> <pre><code class="language-notest"> 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-------------+-----------------------------------------------+ |E| Stream Dependency (31) | +-+-------------+-----------------------------------------------+ | Weight (8) | +-+-------------+-----------------------------------------------+ </code></pre> <p>Where "E" is set if the dependency is exclusive.</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/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-167' class='srclink' href='../../../../src/solicit/http/frame/headers.rs.html#38' 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>(&self, __arg_0: &<a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a>) -> <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>(&self, __arg_0: &<a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a>) -> <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='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-186' class='srclink' href='../../../../src/solicit/http/frame/headers.rs.html#39' 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>(&self, __arg_0: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <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/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-194' class='srclink' href='../../../../src/solicit/http/frame/headers.rs.html#40' 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>(&self) -> <a class='struct' href='../../../../solicit/http/frame/headers/struct.StreamDependency.html' title='solicit::http::frame::headers::StreamDependency'>StreamDependency</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>(&mut self, source: &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></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>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</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>