mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
28 lines
6.2 KiB
HTML
28 lines
6.2 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="Concatenate the buffers from a body into a single `Bytes` asynchronously."><title>to_bytes in hyper::body - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In hyper::body</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/hyper/body/to_bytes.rs.html#47-82">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub async fn to_bytes<T>(body: T) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>><div class="where">where
|
||
T: <a class="trait" href="trait.HttpBody.html" title="trait hyper::body::HttpBody">HttpBody</a>,</div></code></pre><details class="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" title="fn hyper::body::aggregate"><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) => v,
|
||
<span class="prelude-val">None </span>=> 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 < 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">"body: {:?}"</span>, body_bytes);
|
||
}
|
||
</code></pre></div>
|
||
</div></details></section></div></main></body></html> |