| <!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="Streaming bodies for Requests and Responses"><meta name="keywords" content="rust, rustlang, rust-lang, body"><title>hyper::body - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module body</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="#">body</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/hyper/body/mod.rs.html#1-65">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Streaming bodies for Requests and Responses</p> |
| <p>For both <a href="../client/index.html">Clients</a> and <a href="../server/index.html">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="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="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></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Body.html" title="hyper::body::Body struct">Body</a></div><div class="item-right docblock-short">A stream of <code>Bytes</code>, used when receiving bodies.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Bytes.html" title="hyper::body::Bytes struct">Bytes</a></div><div class="item-right docblock-short">A cheaply cloneable and sliceable chunk of contiguous memory.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Sender.html" title="hyper::body::Sender struct">Sender</a></div><div class="item-right docblock-short">A sender half created through <a href="struct.Body.html#method.channel"><code>Body::channel()</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SizeHint.html" title="hyper::body::SizeHint struct">SizeHint</a></div><div class="item-right docblock-short">A <code>Body</code> size hint</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Buf.html" title="hyper::body::Buf trait">Buf</a></div><div class="item-right docblock-short">Read bytes from a buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HttpBody.html" title="hyper::body::HttpBody trait">HttpBody</a></div><div class="item-right docblock-short">Trait representing a streaming body of a Request or Response.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.aggregate.html" title="hyper::body::aggregate fn">aggregate</a></div><div class="item-right docblock-short">Aggregate the data buffers from a body asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_bytes.html" title="hyper::body::to_bytes fn">to_bytes</a></div><div class="item-right docblock-short">Concatenate the buffers from a body into a single <code>Bytes</code> asynchronously.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
