blob: 46ec0827aec916357d696a4c4ec5d356dd0b1663 [file] [log] [blame]
<!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="Concatenate the buffers from a body into a single `Bytes` asynchronously."><meta name="keywords" content="rust, rustlang, rust-lang, to_bytes"><title>to_bytes in 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="sidebar-items.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 fn"><!--[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">&#9776;</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><div class="sidebar-elems"><h2><a href="index.html">In hyper::body</a></h2></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">Function <a href="../index.html">hyper</a>::<wbr><a href="index.html">body</a>::<wbr><a class="fn" href="#">to_bytes</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/to_bytes.rs.html#47-82">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust fn"><code>pub async fn to_bytes&lt;T&gt;(body: T) -&gt; Result&lt;<a class="struct" href="struct.Bytes.html" title="struct hyper::body::Bytes">Bytes</a>, T::<a class="associatedtype" href="trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="trait.HttpBody.html" title="trait hyper::body::HttpBody">HttpBody</a>,</span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Concatenate the buffers from a body into a single <code>Bytes</code> asynchronously.</p>
<p>This may require copying the data into a single buffer. If you don’t need
a contiguous buffer, prefer the <a href="fn.aggregate.html"><code>aggregate</code></a>
function.</p>
<h2 id="note"><a href="#note">Note</a></h2>
<p>Care needs to be taken if the remote is untrusted. The function doesn’t implement any length
checks and an malicious peer might make it consume arbitrary amounts of memory. Checking the
<code>Content-Length</code> is a possibility, but it is not strictly mandated to be present.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hyper::{body::HttpBody};
<span class="kw">let </span>response = client.request(request).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">const </span>MAX_ALLOWED_RESPONSE_SIZE: u64 = <span class="number">1024</span>;
<span class="kw">let </span>response_content_length = <span class="kw">match </span>response.body().size_hint().upper() {
<span class="prelude-val">Some</span>(v) =&gt; v,
<span class="prelude-val">None </span>=&gt; MAX_ALLOWED_RESPONSE_SIZE + <span class="number">1 </span><span class="comment">// Just to protect ourselves from a malicious response
</span>};
<span class="kw">if </span>response_content_length &lt; MAX_ALLOWED_RESPONSE_SIZE {
<span class="kw">let </span>body_bytes = hyper::body::to_bytes(response.into_body()).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="macro">println!</span>(<span class="string">&quot;body: {:?}&quot;</span>, body_bytes);
}
</code></pre></div>
</div></details></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>