mirror of
https://github.com/actix/actix-web.git
synced 2024-05-20 01:08:10 +00:00
22 lines
5.9 KiB
HTML
22 lines
5.9 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="Collects the bytes produced by `body`, up to `limit` bytes."><title>to_bytes_limited in actix_http::body - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-2c208a72533b4dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0-nightly (0d8b3346a 2024-04-14)" data-channel="nightly" data-search-js="search-ffac13a0df2b1870.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-c97aec732c613ca4.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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" title="show sidebar"></button><a class="logo-container" href="../../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_http/index.html">actix_http</a><span class="version">3.6.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_http::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="../../actix_http/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">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">actix_http</a>::<wbr><a href="index.html">body</a>::<wbr><a class="fn" href="#">to_bytes_limited</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/actix_http/body/utils.rs.html#71-119">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_limited<B: <a class="trait" href="trait.MessageBody.html" title="trait actix_http::body::MessageBody">MessageBody</a>>(
|
||
body: B,
|
||
limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, B::<a class="associatedtype" href="trait.MessageBody.html#associatedtype.Error" title="type actix_http::body::MessageBody::Error">Error</a>>, <a class="struct" href="struct.BodyLimitExceeded.html" title="struct actix_http::body::BodyLimitExceeded">BodyLimitExceeded</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Collects the bytes produced by <code>body</code>, up to <code>limit</code> bytes.</p>
|
||
<p>If a chunk read from <code>poll_next</code> causes the total number of bytes read to exceed <code>limit</code>, an
|
||
<code>Err(BodyLimitExceeded)</code> is returned.</p>
|
||
<p>Any errors produced by the body stream are returned immediately as <code>Ok(Err(B::Error))</code>.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_http::body::{<span class="self">self</span>, to_bytes_limited};
|
||
<span class="kw">use </span>bytes::Bytes;
|
||
|
||
<span class="kw">let </span>body = body::None::new();
|
||
<span class="kw">let </span>bytes = to_bytes_limited(body, <span class="number">10</span>).<span class="kw">await</span>.unwrap().unwrap();
|
||
<span class="macro">assert!</span>(bytes.is_empty());
|
||
|
||
<span class="kw">let </span>body = Bytes::from_static(<span class="string">b"123"</span>);
|
||
<span class="kw">let </span>bytes = to_bytes_limited(body, <span class="number">10</span>).<span class="kw">await</span>.unwrap().unwrap();
|
||
<span class="macro">assert_eq!</span>(bytes, <span class="string">"123"</span>);
|
||
|
||
<span class="kw">let </span>body = Bytes::from_static(<span class="string">b"123"</span>);
|
||
<span class="macro">assert!</span>(to_bytes_limited(body, <span class="number">2</span>).<span class="kw">await</span>.is_err());</code></pre></div>
|
||
</div></details></section></div></main></body></html> |