mentat/hyper/header/parsing/index.html

189 lines
8.5 KiB
HTML
Raw Permalink Normal View History

2018-08-22 17:04:13 +00:00
<!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 `parsing` mod in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, parsing">
<title>hyper::header::parsing - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Module parsing</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>hyper</a>::<wbr><a href='../index.html'>header</a></p><script>window.sidebarCurrent = {name: 'parsing', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<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">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>hyper</a>::<wbr><a href='../index.html'>header</a>::<wbr><a class="mod" href=''>parsing</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 class='srclink' href='../../../src/hyper/header/parsing.rs.html#1-249' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Utility functions for Header implementations.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.ExtendedValue.html"
title='struct hyper::header::parsing::ExtendedValue'>ExtendedValue</a></td>
<td class='docblock-short'>
<p>An extended header parameter value (i.e., tagged with a character set and optionally,
a language), as defined in <a href="https://tools.ietf.org/html/rfc5987#section-3.2">RFC 5987</a>.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.fmt_comma_delimited.html"
title='fn hyper::header::parsing::fmt_comma_delimited'>fmt_comma_delimited</a></td>
<td class='docblock-short'>
<p>Format an array into a comma-delimited string.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.from_comma_delimited.html"
title='fn hyper::header::parsing::from_comma_delimited'>from_comma_delimited</a></td>
<td class='docblock-short'>
<p>Reads a comma-delimited raw header into a Vec.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.from_one_raw_str.html"
title='fn hyper::header::parsing::from_one_raw_str'>from_one_raw_str</a></td>
<td class='docblock-short'>
<p>Reads a single raw string when parsing a header.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.from_raw_str.html"
title='fn hyper::header::parsing::from_raw_str'>from_raw_str</a></td>
<td class='docblock-short'>
<p>Reads a raw string into a value.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.http_percent_encode.html"
title='fn hyper::header::parsing::http_percent_encode'>http_percent_encode</a></td>
<td class='docblock-short'>
<p>Percent encode a sequence of bytes with a character set defined in
<a href="https://tools.ietf.org/html/rfc5987#section-3.2">https://tools.ietf.org/html/rfc5987#section-3.2</a></p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.parse_extended_value.html"
title='fn hyper::header::parsing::parse_extended_value'>parse_extended_value</a></td>
<td class='docblock-short'>
<p>Parses extended header parameter values (<code>ext-value</code>), as defined in
<a href="https://tools.ietf.org/html/rfc5987#section-3.2">RFC 5987</a>.</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><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse 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 = "hyper";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>