mentat/hyper/client/conn/index.html
2018-08-22 17:04:13 +00:00

192 lines
No EOL
8.4 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 `conn` mod in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, conn">
<title>hyper::client::conn - 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 conn</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'>client</a></p><script>window.sidebarCurrent = {name: 'conn', 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'>client</a>::<wbr><a class="mod" href=''>conn</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/client/conn.rs.html#1-499' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Lower-level client connection API.</p>
<p>The types in thie module are to provide a lower-level API based around a
single connection. Connecting to a host, pooling connections, and the like
are not handled at this level. This module provides the building blocks to
customize those things externally.</p>
<p>If don't have need to manage connections yourself, consider using the
higher-level <a href="super">Client</a> API.</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.Builder.html"
title='struct hyper::client::conn::Builder'>Builder</a></td>
<td class='docblock-short'>
<p>A builder to configure an HTTP connection.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Connection.html"
title='struct hyper::client::conn::Connection'>Connection</a></td>
<td class='docblock-short'>
<p>A future that processes all HTTP state for the IO object.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Handshake.html"
title='struct hyper::client::conn::Handshake'>Handshake</a></td>
<td class='docblock-short'>
<p>A future setting up HTTP over an IO object.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Parts.html"
title='struct hyper::client::conn::Parts'>Parts</a></td>
<td class='docblock-short'>
<p>Deconstructed parts of a <code>Connection</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ResponseFuture.html"
title='struct hyper::client::conn::ResponseFuture'>ResponseFuture</a></td>
<td class='docblock-short'>
<p>A future returned by <code>SendRequest::send_request</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SendRequest.html"
title='struct hyper::client::conn::SendRequest'>SendRequest</a></td>
<td class='docblock-short'>
<p>The sender side of an established connection.</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.handshake.html"
title='fn hyper::client::conn::handshake'>handshake</a></td>
<td class='docblock-short'>
<p>Returns a <code>Handshake</code> future over some IO.</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>