actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2025-06-30 08:24:28 +02:00
Code Issues Releases Wiki Activity

Deploying to gh-pages from @ actix/actix-web@26efa64278 🚀

Browse Source
This commit is contained in:
github-merge-queue[bot]
2024-05-27 01:16:31 +00:00
commit a33fe13cd1
1715 changed files with 215638 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
actix_multipart/test/fn.create_form_data_payload_and_headers.html Normal file
View File

@ -0,0 +1,44 @@
<!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="Constructs a `multipart/form-data` payload from bytes and metadata."><title>create_form_data_payload_and_headers in actix_multipart::test - 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_multipart" 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_multipart/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_multipart/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_multipart/index.html">actix_multipart</a><span class="version">0.6.1</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_multipart::test</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_multipart</a>::<wbr><a href="index.html">test</a>::<wbr><a class="fn" href="#">create_form_data_payload_and_headers</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_multipart/test.rs.html#58-73">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn create_form_data_payload_and_headers(
name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
filename: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
content_type: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://docs.rs/mime/0.3.17/mime/struct.Mime.html" title="struct mime::Mime">Mime</a>&gt;,
file: Bytes
) -&gt; (Bytes, HeaderMap)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Constructs a <code>multipart/form-data</code> payload from bytes and metadata.</p>
<p>Returned header map can be extended or merged with existing headers.</p>
<p>Multipart boundary used is a random alphanumeric string.</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_multipart::test::create_form_data_payload_and_headers;
<span class="kw">use </span>actix_web::test::TestRequest;
<span class="kw">use </span>bytes::Bytes;
<span class="kw">use </span>memchr::memmem::find;
<span class="kw">let </span>(body, headers) = create_form_data_payload_and_headers(
<span class="string">"foo"</span>,
<span class="prelude-val">Some</span>(<span class="string">"lorem.txt"</span>.to_owned()),
<span class="prelude-val">Some</span>(mime::TEXT_PLAIN_UTF_8),
Bytes::from_static(<span class="string">b"Lorem ipsum."</span>),
);
<span class="macro">assert!</span>(find(<span class="kw-2">&amp;</span>body, <span class="string">b"foo"</span>).is_some());
<span class="macro">assert!</span>(find(<span class="kw-2">&amp;</span>body, <span class="string">b"lorem.txt"</span>).is_some());
<span class="macro">assert!</span>(find(<span class="kw-2">&amp;</span>body, <span class="string">b"text/plain; charset=utf-8"</span>).is_some());
<span class="macro">assert!</span>(find(<span class="kw-2">&amp;</span>body, <span class="string">b"Lorem ipsum."</span>).is_some());
<span class="kw">let </span>req = TestRequest::default();
<span class="comment">// merge header map into existing test request and set multipart body
</span><span class="kw">let </span>req = headers
.into_iter()
.fold(req, |req, hdr| req.insert_header(hdr))
.set_payload(body)
.to_http_request();
<span class="macro">assert!</span>(
req.headers()
.get(<span class="string">"content-type"</span>)
.unwrap()
.to_str()
.unwrap()
.starts_with(<span class="string">"multipart/form-data; boundary=\""</span>)
);</code></pre></div>
</div></details></section></div></main></body></html>

9
actix_multipart/test/fn.create_form_data_payload_and_headers_with_boundary.html Normal file
View File

@ -0,0 +1,9 @@
<!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="Constructs a `multipart/form-data` payload from bytes and metadata with a fixed boundary."><title>create_form_data_payload_and_headers_with_boundary in actix_multipart::test - 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_multipart" 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_multipart/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_multipart/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_multipart/index.html">actix_multipart</a><span class="version">0.6.1</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In actix_multipart::test</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_multipart</a>::<wbr><a href="index.html">test</a>::<wbr><a class="fn" href="#">create_form_data_payload_and_headers_with_boundary</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_multipart/test.rs.html#78-125">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn create_form_data_payload_and_headers_with_boundary(
boundary: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
filename: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
content_type: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://docs.rs/mime/0.3.17/mime/struct.Mime.html" title="struct mime::Mime">Mime</a>&gt;,
file: Bytes
) -&gt; (Bytes, HeaderMap)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Constructs a <code>multipart/form-data</code> payload from bytes and metadata with a fixed boundary.</p>
<p>See <a href="fn.create_form_data_payload_and_headers.html" title="fn actix_multipart::test::create_form_data_payload_and_headers"><code>create_form_data_payload_and_headers</code></a> for more details.</p>
</div></details></section></div></main></body></html>

1
actix_multipart/test/index.html Normal file
View File

@ -0,0 +1 @@
<!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="API documentation for the Rust `test` mod in crate `actix_multipart`."><title>actix_multipart::test - 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_multipart" 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_multipart/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_multipart/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_multipart/index.html">actix_multipart</a><span class="version">0.6.1</span></h2></div><h2 class="location"><a href="#">Module test</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate actix_multipart</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_multipart</a>::<wbr><a class="mod" href="#">test</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_multipart/test.rs.html#1-217">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><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.create_form_data_payload_and_headers.html" title="fn actix_multipart::test::create_form_data_payload_and_headers">create_form_data_payload_and_headers</a></div><div class="desc docblock-short">Constructs a <code>multipart/form-data</code> payload from bytes and metadata.</div></li><li><div class="item-name"><a class="fn" href="fn.create_form_data_payload_and_headers_with_boundary.html" title="fn actix_multipart::test::create_form_data_payload_and_headers_with_boundary">create_form_data_payload_and_headers_with_boundary</a></div><div class="desc docblock-short">Constructs a <code>multipart/form-data</code> payload from bytes and metadata with a fixed boundary.</div></li></ul></section></div></main></body></html>

1
actix_multipart/test/sidebar-items.js Normal file
View File

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["create_form_data_payload_and_headers","create_form_data_payload_and_headers_with_boundary"]};