actix-web/actix_web/body/index.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="Traits and structures to aid consuming and writing HTTP payloads."><title>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 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" 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><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="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate actix_web</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>Module <a href="../index.html">actix_web</a>::<wbr><a class="mod" href="#">body</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/lib.rs.html#36">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Traits and structures to aid consuming and writing HTTP payloads.</p>
<p>“Body” and “payload” are used somewhat interchangeably in this documentation.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BodyLimitExceeded.html" title="struct actix_web::body::BodyLimitExceeded">BodyLimitExceeded</a></div><div class="desc docblock-short">Error type returned from <a href="fn.to_bytes_limited.html" title="fn actix_web::body::to_bytes_limited"><code>to_bytes_limited</code></a> when body produced exceeds limit.</div></li><li><div class="item-name"><a class="struct" href="struct.BodyStream.html" title="struct actix_web::body::BodyStream">BodyStream</a></div><div class="desc docblock-short">Streaming response wrapper.</div></li><li><div class="item-name"><a class="struct" href="struct.BoxBody.html" title="struct actix_web::body::BoxBody">BoxBody</a></div><div class="desc docblock-short">A boxed message body with boxed errors.</div></li><li><div class="item-name"><a class="struct" href="struct.None.html" title="struct actix_web::body::None">None</a></div><div class="desc docblock-short">Body type for responses that forbid payloads.</div></li><li><div class="item-name"><a class="struct" href="struct.SizedStream.html" title="struct actix_web::body::SizedStream">SizedStream</a></div><div class="desc docblock-short">Known sized streaming response wrapper.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BodySize.html" title="enum actix_web::body::BodySize">BodySize</a></div><div class="desc docblock-short">Body size hint.</div></li><li><div class="item-name"><a class="enum" href="enum.EitherBody.html" title="enum actix_web::body::EitherBody">EitherBody</a></div><div class="desc docblock-short">An “either” type specialized for body types.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.MessageBody.html" title="trait actix_web::body::MessageBody">MessageBody</a></div><div class="desc docblock-short">An interface for types that can be used as a response body.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.to_bytes.html" title="fn actix_web::body::to_bytes">to_bytes</a></div><div class="desc docblock-short">Collects all the bytes produced by <code>body</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.to_bytes_limited.html" title="fn actix_web::body::to_bytes_limited">to_bytes_limited</a></div><div class="desc docblock-short">Collects the bytes produced by <code>body</code>, up to <code>limit</code> bytes.</div></li></ul></section></div></main></body></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="Traits and structures to aid consuming and writing HTTP payloads."><title>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 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" 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><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="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate actix_web</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>Module <a href="../index.html">actix_web</a>::<wbr><a class="mod" href="#">body</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/lib.rs.html#36">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Traits and structures to aid consuming and writing HTTP payloads.</p>
	`<p>“Body” and “payload” are used somewhat interchangeably in this documentation.</p>`
	</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BodyLimitExceeded.html" title="struct actix_web::body::BodyLimitExceeded">BodyLimitExceeded</a></div><div class="desc docblock-short">Error type returned from <a href="fn.to_bytes_limited.html" title="fn actix_web::body::to_bytes_limited"><code>to_bytes_limited</code></a> when body produced exceeds limit.</div></li><li><div class="item-name"><a class="struct" href="struct.BodyStream.html" title="struct actix_web::body::BodyStream">BodyStream</a></div><div class="desc docblock-short">Streaming response wrapper.</div></li><li><div class="item-name"><a class="struct" href="struct.BoxBody.html" title="struct actix_web::body::BoxBody">BoxBody</a></div><div class="desc docblock-short">A boxed message body with boxed errors.</div></li><li><div class="item-name"><a class="struct" href="struct.None.html" title="struct actix_web::body::None">None</a></div><div class="desc docblock-short">Body type for responses that forbid payloads.</div></li><li><div class="item-name"><a class="struct" href="struct.SizedStream.html" title="struct actix_web::body::SizedStream">SizedStream</a></div><div class="desc docblock-short">Known sized streaming response wrapper.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BodySize.html" title="enum actix_web::body::BodySize">BodySize</a></div><div class="desc docblock-short">Body size hint.</div></li><li><div class="item-name"><a class="enum" href="enum.EitherBody.html" title="enum actix_web::body::EitherBody">EitherBody</a></div><div class="desc docblock-short">An “either” type specialized for body types.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.MessageBody.html" title="trait actix_web::body::MessageBody">MessageBody</a></div><div class="desc docblock-short">An interface for types that can be used as a response body.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.to_bytes.html" title="fn actix_web::body::to_bytes">to_bytes</a></div><div class="desc docblock-short">Collects all the bytes produced by <code>body</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.to_bytes_limited.html" title="fn actix_web::body::to_bytes_limited">to_bytes_limited</a></div><div class="desc docblock-short">Collects the bytes produced by <code>body</code>, up to <code>limit</code> bytes.</div></li></ul></section></div></main></body></html>