175 lines
7.9 KiB
HTML
175 lines
7.9 KiB
HTML
|
<!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` mod in crate `hpack`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, decoder">
|
|||
|
|
|
|||
|
|
<title>hpack::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></p><script>window.sidebarCurrent = {name: 'decoder', ty: 'mod', 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 mod">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>hpack</a>::<wbr><a class='mod' 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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a id='src-59' class='srclink' href='../../src/hpack/decoder.rs.html#1-1484' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Exposes the struct <code>Decoder</code> that allows for HPACK-encoded header blocks to
|
|||
|
|
be decoded into a header list.</p>
|
|||
|
|
|
|||
|
|
<p>The decoder only follows HPACK rules, without performing any additional
|
|||
|
|
(semantic) checks on the header name/value pairs, i.e. it considers the
|
|||
|
|
headers as opaque octets.</p>
|
|||
|
|
|
|||
|
|
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
|
|||
|
|
<p>A simple example of using the decoder that demonstrates its API:</p>
|
|||
|
|
|
|||
|
|
<pre class='rust rust-example-rendered'>
|
|||
|
|
<span class='kw'>use</span> <span class='ident'>hpack</span>::<span class='ident'>Decoder</span>;
|
|||
|
|
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>decoder</span> <span class='op'>=</span> <span class='ident'>Decoder</span>::<span class='ident'>new</span>();
|
|||
|
|
|
|||
|
|
<span class='kw'>let</span> <span class='ident'>header_list</span> <span class='op'>=</span> <span class='ident'>decoder</span>.<span class='ident'>decode</span>(<span class='kw-2'>&</span>[<span class='number'>0x82</span>, <span class='number'>0x84</span>]).<span class='ident'>unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>header_list</span>, [
|
|||
|
|
(<span class='string'>b":method"</span>.<span class='ident'>to_vec</span>(), <span class='string'>b"GET"</span>.<span class='ident'>to_vec</span>()),
|
|||
|
|
(<span class='string'>b":path"</span>.<span class='ident'>to_vec</span>(), <span class='string'>b"/"</span>.<span class='ident'>to_vec</span>()),
|
|||
|
|
]);</pre>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='struct' href='struct.Decoder.html'
|
|||
|
|
title='hpack::decoder::Decoder'>Decoder</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Decodes headers encoded using HPACK.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='enum' href='enum.DecoderError.html'
|
|||
|
|
title='hpack::decoder::DecoderError'>DecoderError</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Represents all errors that can be encountered while performing the decoding
|
|||
|
|
of an HPACK header set.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='enum' href='enum.IntegerDecodingError.html'
|
|||
|
|
title='hpack::decoder::IntegerDecodingError'>IntegerDecodingError</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Represents all errors that can be encountered while decoding an
|
|||
|
|
integer.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='enum' href='enum.StringDecodingError.html'
|
|||
|
|
title='hpack::decoder::StringDecodingError'>StringDecodingError</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Represents all errors that can be encountered while decoding an octet
|
|||
|
|
string.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.DecoderResult.html'
|
|||
|
|
title='hpack::decoder::DecoderResult'>DecoderResult</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>The result returned by the <code>decode</code> method of the <code>Decoder</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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 = "hpack";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../jquery.js"></script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|