244 lines
12 KiB
HTML
244 lines
12 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 `hyper` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, hyper">
|
|||
|
|
|
|||
|
|
<title>hyper - 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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Crate hyper</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'hyper', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>hyper</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 class='srclink' href='../src/hyper/lib.rs.html#1-84' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><h1 id="hyper" class="section-header"><a href="#hyper">Hyper</a></h1>
|
|||
|
|
<p>Hyper is a fast, modern HTTP implementation written in and for Rust. It
|
|||
|
|
is a low-level typesafe abstraction over raw HTTP, providing an elegant
|
|||
|
|
layer over "stringly-typed" HTTP.</p>
|
|||
|
|
<p>Hyper provides both a <a href="client/index.html">Client</a> and a
|
|||
|
|
<a href="server/index.html">Server</a>, along with a
|
|||
|
|
<a href="header/index.html">typed Headers system</a>.</p>
|
|||
|
|
<p>If just starting out, <strong>check out the <a href="https://hyper.rs/guides">Guides</a>
|
|||
|
|
first.</strong></p>
|
|||
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|||
|
|
<table><tr><td><code>pub extern crate <a class="mod" href="../mime/index.html" title="mod mime">mime</a>;</code></td></tr><tr><td><code>pub use client::<a class="struct" href="../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a>;</code></td></tr><tr><td><code>pub use error::<a class="type" href="../hyper/error/type.Result.html" title="type hyper::error::Result">Result</a>;</code></td></tr><tr><td><code>pub use error::<a class="enum" href="../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a>;</code></td></tr><tr><td><code>pub use header::<a class="struct" href="../hyper/header/struct.Headers.html" title="struct hyper::header::Headers">Headers</a>;</code></td></tr><tr><td><code>pub use method::Method::<a class="enum" href="../hyper/enum.Method.html" title="enum hyper::Method">Get</a>;</code></td></tr><tr><td><code>pub use method::Method::<a class="enum" href="../hyper/enum.Method.html" title="enum hyper::Method">Head</a>;</code></td></tr><tr><td><code>pub use method::Method::<a class="enum" href="../hyper/enum.Method.html" title="enum hyper::Method">Post</a>;</code></td></tr><tr><td><code>pub use method::Method::<a class="enum" href="../hyper/enum.Method.html" title="enum hyper::Method">Put</a>;</code></td></tr><tr><td><code>pub use method::Method::<a class="enum" href="../hyper/enum.Method.html" title="enum hyper::Method">Delete</a>;</code></td></tr><tr><td><code>pub use status::StatusCode::<a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">Ok</a>;</code></td></tr><tr><td><code>pub use status::StatusCode::<a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">BadRequest</a>;</code></td></tr><tr><td><code>pub use status::StatusCode::<a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">NotFound</a>;</code></td></tr><tr><td><code>pub use server::<a class="struct" href="../hyper/server/struct.Server.html" title="struct hyper::server::Server">Server</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="client/index.html"
|
|||
|
|
title='mod hyper::client'>client</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>HTTP Client</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="error/index.html"
|
|||
|
|
title='mod hyper::error'>error</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Error and Result module.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="header/index.html"
|
|||
|
|
title='mod hyper::header'>header</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Headers container, and common header fields.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="server/index.html"
|
|||
|
|
title='mod hyper::server'>server</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>HTTP Server</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.header.html"
|
|||
|
|
title='macro hyper::header'>header</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Body.html"
|
|||
|
|
title='struct hyper::Body'>Body</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A <code>Stream</code> for <code>Chunk</code>s used in requests and responses.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Chunk.html"
|
|||
|
|
title='struct hyper::Chunk'>Chunk</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A piece of a message body.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Request.html"
|
|||
|
|
title='struct hyper::Request'>Request</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An HTTP Request</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Response.html"
|
|||
|
|
title='struct hyper::Response'>Response</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An HTTP Response</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Uri.html"
|
|||
|
|
title='struct hyper::Uri'>Uri</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The Request-URI of a Request's StartLine.</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.HttpVersion.html"
|
|||
|
|
title='enum hyper::HttpVersion'>HttpVersion</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Represents a version of the HTTP spec.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Method.html"
|
|||
|
|
title='enum hyper::Method'>Method</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The Request Method (VERB)</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.StatusCode.html"
|
|||
|
|
title='enum hyper::StatusCode'>StatusCode</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An HTTP status code (<code>status-code</code> in RFC 7230 et al.).</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>⏎</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>
|