juniper/hpack/index.html
Juniper Documentation Builder 95d942c9d4 Update documentation for Juniper
2016-09-11 18:41:24 +00:00

146 lines
No EOL
5.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `hpack` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, hpack">
<title>hpack - 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'></p><script>window.sidebarCurrent = {name: 'hpack', ty: 'mod', relpath: '../'};</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'>Crate <a class='mod' href=''>hpack</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-0' class='srclink' href='../src/hpack/lib.rs.html#1-761' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A module implementing HPACK functionality. Exposes a simple API for
performing the encoding and decoding of header sets, according to the
HPACK spec.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
<table><tr><td><code>pub use self::<a class='mod'
href='./decoder/index.html'>decoder</a>::<a class='struct' href='../hpack/decoder/struct.Decoder.html' title='hpack::decoder::Decoder'>Decoder</a>;</code></td></tr><tr><td><code>pub use self::<a class='mod'
href='./encoder/index.html'>encoder</a>::<a class='struct' href='../hpack/encoder/struct.Encoder.html' title='hpack::encoder::Encoder'>Encoder</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class='mod' href='decoder/index.html'
title='hpack::decoder'>decoder</a></td>
<td class='docblock short'>
<p>Exposes the struct <code>Decoder</code> that allows for HPACK-encoded header blocks to
be decoded into a header list.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='encoder/index.html'
title='hpack::encoder'>encoder</a></td>
<td class='docblock short'>
<p>Implements all functionality related to encoding header blocks using
HPACK.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='mod' href='huffman/index.html'
title='hpack::huffman'>huffman</a></td>
<td class='docblock short'>
<p>A module exposing utilities for encoding and decoding Huffman-coded octet
strings, under the Huffman code defined by HPACK.
(HPACK-draft-10, Appendix B)</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>&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>