<!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 `Decoder` struct in crate `hpack`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, Decoder">

    <title>hpack::decoder::Decoder - 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'>hpack</a>::<wbr><a href='index.html'>decoder</a></p><script>window.sidebarCurrent = {name: 'Decoder', 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'>hpack</a>::<wbr><a href='index.html'>decoder</a>::<wbr><a class='struct' href=''>Decoder</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-202' class='srclink' href='../../src/hpack/decoder.rs.html#228-231' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Decoder&lt;'a&gt; {
    // some fields omitted
}</pre><div class='docblock'><p>Decodes headers encoded using HPACK.</p>

<p>For now, incremental decoding is not supported, i.e. it is necessary
to pass in the entire encoded representation of all headers to the
decoder, rather than processing it piece-by-piece.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class='struct' href='../../hpack/decoder/struct.Decoder.html' title='hpack::decoder::Decoder'>Decoder</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a id='src-205' class='srclink' href='../../src/hpack/decoder.rs.html#235-403' title='goto source code'>[src]</a></span></h3>
<div class='docblock'><p>Represents a decoder of HPACK encoded headers. Maintains the state
necessary to correctly decode subsequent HPACK blocks.</p>
</div><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class='struct' href='../../hpack/decoder/struct.Decoder.html' title='hpack::decoder::Decoder'>Decoder</a>&lt;'a&gt;</code></h4>
<div class='docblock'><p>Creates a new <code>Decoder</code> with all settings set to default values.</p>
</div><h4 id='method.set_max_table_size' class='method'><code>fn <a href='#method.set_max_table_size' class='fnname'>set_max_table_size</a>(&amp;mut self, new_max_size: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>)</code></h4>
<div class='docblock'><p>Sets a new maximum dynamic table size for the decoder.</p>
</div><h4 id='method.decode' class='method'><code>fn <a href='#method.decode' class='fnname'>decode</a>(&amp;mut self, buf: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;[</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='type' href='../../hpack/decoder/type.DecoderResult.html' title='hpack::decoder::DecoderResult'>DecoderResult</a></code></h4>
<div class='docblock'><p>Decode the header block found in the given buffer.</p>

<p>The buffer should represent the entire block that should be decoded.
For example, in HTTP/2, all continuation frames need to be concatenated
to a single buffer before passing them to the decoder.</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 = "hpack";
        window.playgroundUrl = "";
    </script>
    <script src="../../jquery.js"></script>
    <script src="../../main.js"></script>
    
    <script defer src="../../search-index.js"></script>
</body>
</html>