mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-27 17:52:56 +01:00
23 lines
5.6 KiB
HTML
23 lines
5.6 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_web::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-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_web" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.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_web/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_web/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_web/index.html">actix_web</a><span class="version">4.6.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_web::body</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">actix_web</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-74">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>(
|
|
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><<a class="struct" href="../web/struct.Bytes.html" title="struct actix_web::web::Bytes">Bytes</a>, <B as <a class="trait" href="trait.MessageBody.html" title="trait actix_web::body::MessageBody">MessageBody</a>>::<a class="associatedtype" href="trait.MessageBody.html#associatedtype.Error" title="type actix_web::body::MessageBody::Error">Error</a>>, <a class="struct" href="struct.BodyLimitExceeded.html" title="struct actix_web::body::BodyLimitExceeded">BodyLimitExceeded</a>><div class="where">where
|
|
B: <a class="trait" href="trait.MessageBody.html" title="trait actix_web::body::MessageBody">MessageBody</a>,</div></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> |