167 lines
No EOL
10 KiB
HTML
167 lines
No EOL
10 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 `Encoder` struct in crate `hpack`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Encoder">
|
||
|
||
<title>hpack::encoder::Encoder - 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'>encoder</a></p><script>window.sidebarCurrent = {name: 'Encoder', 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'>encoder</a>::<wbr><a class='struct' href=''>Encoder</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-22' class='srclink' href='../../src/hpack/encoder.rs.html#121-124' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Encoder<'a> {
|
||
// some fields omitted
|
||
}</pre><div class='docblock'><p>Represents an HPACK encoder. Allows clients to encode arbitrary header sets
|
||
and tracks the encoding context. That is, encoding subsequent header sets
|
||
will use the context built by previous encode calls.</p>
|
||
|
||
<p>This is the main API for performing HPACK encoding of headers.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<p>Encoding a header two times in a row produces two different
|
||
representations, due to the utilization of HPACK compression.</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>hpack</span>::<span class='ident'>Encoder</span>;
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>encoder</span> <span class='op'>=</span> <span class='ident'>Encoder</span>::<span class='ident'>new</span>();
|
||
|
||
<span class='kw'>let</span> <span class='ident'>headers</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[
|
||
(<span class='string'>b"custom-key"</span>.<span class='ident'>to_vec</span>(), <span class='string'>b"custom-value"</span>.<span class='ident'>to_vec</span>()),
|
||
];
|
||
<span class='comment'>// First encoding...</span>
|
||
<span class='kw'>let</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='ident'>encoder</span>.<span class='ident'>encode</span>(<span class='kw-2'>&</span><span class='ident'>headers</span>);
|
||
<span class='comment'>// The result is a literal encoding of the header name and value, with an</span>
|
||
<span class='comment'>// initial byte representing the type of the encoding</span>
|
||
<span class='comment'>// (incremental indexing).</span>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(
|
||
<span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>0x40</span>,
|
||
<span class='number'>10</span>, <span class='string'>b'c'</span>, <span class='string'>b'u'</span>, <span class='string'>b's'</span>, <span class='string'>b't'</span>, <span class='string'>b'o'</span>, <span class='string'>b'm'</span>, <span class='string'>b'-'</span>, <span class='string'>b'k'</span>, <span class='string'>b'e'</span>, <span class='string'>b'y'</span>,
|
||
<span class='number'>12</span>, <span class='string'>b'c'</span>, <span class='string'>b'u'</span>, <span class='string'>b's'</span>, <span class='string'>b't'</span>, <span class='string'>b'o'</span>, <span class='string'>b'm'</span>, <span class='string'>b'-'</span>, <span class='string'>b'v'</span>, <span class='string'>b'a'</span>, <span class='string'>b'l'</span>,
|
||
<span class='string'>b'u'</span>, <span class='string'>b'e'</span>],
|
||
<span class='ident'>result</span>);
|
||
|
||
<span class='comment'>// Encode the same headers again!</span>
|
||
<span class='kw'>let</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='ident'>encoder</span>.<span class='ident'>encode</span>(<span class='kw-2'>&</span><span class='ident'>headers</span>);
|
||
<span class='comment'>// The result is simply the index of the header in the header table (62),</span>
|
||
<span class='comment'>// with a flag representing that the decoder should use the index.</span>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>0x80</span> <span class='op'>|</span> <span class='number'>62</span>], <span class='ident'>result</span>);</pre>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a> <a class='struct' href='../../hpack/encoder/struct.Encoder.html' title='hpack::encoder::Encoder'>Encoder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-25' class='srclink' href='../../src/hpack/encoder.rs.html#126-239' 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>() -> <a class='struct' href='../../hpack/encoder/struct.Encoder.html' title='hpack::encoder::Encoder'>Encoder</a><'a></code></h4>
|
||
<div class='docblock'><p>Creates a new <code>Encoder</code> with a default static table, as defined by the
|
||
HPACK spec (Appendix A).</p>
|
||
</div><h4 id='method.encode' class='method'><code>fn <a href='#method.encode' class='fnname'>encode</a>(&mut self, headers: &<a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a><a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>>, <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</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.tuple.html'>)</a>>) -> <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>></code></h4>
|
||
<div class='docblock'><p>Encodes the given headers using the HPACK rules and returns a newly
|
||
allocated <code>Vec</code> containing the bytes representing the encoded header
|
||
set.</p>
|
||
|
||
<p>The encoder so far supports only a single, extremely simple encoding
|
||
strategy, whereby each header is represented as an indexed header if
|
||
already found in the header table and a literal otherwise. When a
|
||
header isn't found in the table, it is added if the header name wasn't
|
||
found either (i.e. there are never two header names with different
|
||
values in the produced header table). Strings are always encoded as
|
||
literals (Huffman encoding is not used).</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 = "hpack";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |