github-actions[bot]
30 lines
6.5 KiB
HTML
30 lines
6.5 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 `body` mod in crate `hyper`."><meta name="keywords" content="rust, rustlang, rust-lang, body"><title>hyper::body - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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><a href='../../hyper/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module body</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"><a href="../index.html">hyper</a></p><script>window.sidebarCurrent = {name: "body", 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!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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/body/mod.rs.html#1-65" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="">body</a></span></h1><div class="docblock"><p>Streaming bodies for Requests and Responses</p>
|
||
<p>For both <a href="../../hyper/client/index.html">Clients</a> and <a href="crate::server">Servers</a>, requests and
|
||
responses use streaming bodies, instead of complete buffering. This
|
||
allows applications to not use memory they don't need, and allows exerting
|
||
back-pressure on connections by only reading when asked.</p>
|
||
<p>There are two pieces to this in hyper:</p>
|
||
<ul>
|
||
<li><strong>The <a href="../../hyper/body/trait.HttpBody.html"><code>HttpBody</code></a> trait</strong> describes all possible bodies.
|
||
hyper allows any body type that implements <code>HttpBody</code>, allowing
|
||
applications to have fine-grained control over their streaming.</li>
|
||
<li><strong>The <a href="../../hyper/body/struct.Body.html"><code>Body</code></a> concrete type</strong>, which is an implementation of
|
||
<code>HttpBody</code>, and returned by hyper as a "receive stream" (so, for server
|
||
requests and client responses). It is also a decent default implementation
|
||
if you don't have very custom needs of your send streams.</li>
|
||
</ul>
|
||
</div><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="hyper::body::Body struct">Body</a></td><td class="docblock-short"><p>A stream of <code>Bytes</code>, used when receiving bodies.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Bytes.html" title="hyper::body::Bytes struct">Bytes</a></td><td class="docblock-short"><p>A cheaply cloneable and sliceable chunk of contiguous memory.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Sender.html" title="hyper::body::Sender struct">Sender</a></td><td class="docblock-short"><p>A sender half created through <a href="struct.Body.html#method.channel"><code>Body::channel()</code></a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SizeHint.html" title="hyper::body::SizeHint struct">SizeHint</a></td><td class="docblock-short"><p>A <code>Body</code> size hint</p>
|
||
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||
<table><tr class="module-item"><td><a class="trait" href="trait.Buf.html" title="hyper::body::Buf trait">Buf</a></td><td class="docblock-short"><p>Read bytes from a buffer.</p>
|
||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.HttpBody.html" title="hyper::body::HttpBody trait">HttpBody</a></td><td class="docblock-short"><p>Trait representing a streaming body of a Request or Response.</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.aggregate.html" title="hyper::body::aggregate fn">aggregate</a></td><td class="docblock-short"><p>Aggregate the data buffers from a body asynchronously.</p>
|
||
</td></tr><tr class="module-item"><td><a class="fn" href="fn.to_bytes.html" title="hyper::body::to_bytes fn">to_bytes</a></td><td class="docblock-short"><p>Concatenate the buffers from a body into a single <code>Bytes</code> asynchronously.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "hyper";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |