mirror of
https://github.com/fafhrd91/actix-web
synced 2025-07-01 00:44:26 +02:00
Deploying to gh-pages from @ actix/actix-web@26efa64278 🚀
This commit is contained in:
github-merge-queue[bot]
199
src/actix_multipart/error.rs.html
Normal file
199
src/actix_multipart/error.rs.html
Normal file
@ -0,0 +1,199 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/error.rs`."><title>error.rs - source</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="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
<a href="#62" id="62">62</a>
|
||||
<a href="#63" id="63">63</a>
|
||||
<a href="#64" id="64">64</a>
|
||||
<a href="#65" id="65">65</a>
|
||||
<a href="#66" id="66">66</a>
|
||||
<a href="#67" id="67">67</a>
|
||||
<a href="#68" id="68">68</a>
|
||||
<a href="#69" id="69">69</a>
|
||||
<a href="#70" id="70">70</a>
|
||||
<a href="#71" id="71">71</a>
|
||||
<a href="#72" id="72">72</a>
|
||||
<a href="#73" id="73">73</a>
|
||||
<a href="#74" id="74">74</a>
|
||||
<a href="#75" id="75">75</a>
|
||||
<a href="#76" id="76">76</a>
|
||||
<a href="#77" id="77">77</a>
|
||||
<a href="#78" id="78">78</a>
|
||||
<a href="#79" id="79">79</a>
|
||||
<a href="#80" id="80">80</a>
|
||||
<a href="#81" id="81">81</a>
|
||||
<a href="#82" id="82">82</a>
|
||||
<a href="#83" id="83">83</a>
|
||||
<a href="#84" id="84">84</a>
|
||||
<a href="#85" id="85">85</a>
|
||||
<a href="#86" id="86">86</a>
|
||||
<a href="#87" id="87">87</a>
|
||||
<a href="#88" id="88">88</a>
|
||||
<a href="#89" id="89">89</a>
|
||||
<a href="#90" id="90">90</a>
|
||||
<a href="#91" id="91">91</a>
|
||||
<a href="#92" id="92">92</a>
|
||||
<a href="#93" id="93">93</a>
|
||||
<a href="#94" id="94">94</a>
|
||||
<a href="#95" id="95">95</a>
|
||||
<a href="#96" id="96">96</a>
|
||||
<a href="#97" id="97">97</a>
|
||||
<a href="#98" id="98">98</a>
|
||||
<a href="#99" id="99">99</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Error and Result module
|
||||
|
||||
</span><span class="kw">use </span>actix_web::{
|
||||
error::{ParseError, PayloadError},
|
||||
http::StatusCode,
|
||||
ResponseError,
|
||||
};
|
||||
<span class="kw">use </span>derive_more::{Display, Error, From};
|
||||
|
||||
<span class="doccomment">/// A set of errors that can occur during parsing multipart streams.
|
||||
</span><span class="attr">#[derive(Debug, Display, From, Error)]
|
||||
#[non_exhaustive]
|
||||
</span><span class="kw">pub enum </span>MultipartError {
|
||||
<span class="doccomment">/// Content-Disposition header is not found or is not equal to "form-data".
|
||||
///
|
||||
/// According to [RFC 7578 §4.2](https://datatracker.ietf.org/doc/html/rfc7578#section-4.2) a
|
||||
/// Content-Disposition header must always be present and equal to "form-data".
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"No Content-Disposition `form-data` header"</span>)]
|
||||
</span>NoContentDisposition,
|
||||
|
||||
<span class="doccomment">/// Content-Type header is not found
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"No Content-Type header found"</span>)]
|
||||
</span>NoContentType,
|
||||
|
||||
<span class="doccomment">/// Can not parse Content-Type header
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Can not parse Content-Type header"</span>)]
|
||||
</span>ParseContentType,
|
||||
|
||||
<span class="doccomment">/// Multipart boundary is not found
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Multipart boundary is not found"</span>)]
|
||||
</span>Boundary,
|
||||
|
||||
<span class="doccomment">/// Nested multipart is not supported
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Nested multipart is not supported"</span>)]
|
||||
</span>Nested,
|
||||
|
||||
<span class="doccomment">/// Multipart stream is incomplete
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Multipart stream is incomplete"</span>)]
|
||||
</span>Incomplete,
|
||||
|
||||
<span class="doccomment">/// Error during field parsing
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"{}"</span>, _0)]
|
||||
</span>Parse(ParseError),
|
||||
|
||||
<span class="doccomment">/// Payload error
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"{}"</span>, _0)]
|
||||
</span>Payload(PayloadError),
|
||||
|
||||
<span class="doccomment">/// Not consumed
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Multipart stream is not consumed"</span>)]
|
||||
</span>NotConsumed,
|
||||
|
||||
<span class="doccomment">/// An error from a field handler in a form
|
||||
</span><span class="attr">#[display(
|
||||
fmt = <span class="string">"An error occurred processing field `{}`: {}"</span>,
|
||||
field_name,
|
||||
source
|
||||
)]
|
||||
</span>Field {
|
||||
field_name: String,
|
||||
source: actix_web::Error,
|
||||
},
|
||||
|
||||
<span class="doccomment">/// Duplicate field
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Duplicate field found for: `{}`"</span>, _0)]
|
||||
#[from(ignore)]
|
||||
</span>DuplicateField(<span class="attr">#[error(not(source))] </span>String),
|
||||
|
||||
<span class="doccomment">/// Missing field
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Field with name `{}` is required"</span>, _0)]
|
||||
#[from(ignore)]
|
||||
</span>MissingField(<span class="attr">#[error(not(source))] </span>String),
|
||||
|
||||
<span class="doccomment">/// Unknown field
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Unsupported field `{}`"</span>, _0)]
|
||||
#[from(ignore)]
|
||||
</span>UnsupportedField(<span class="attr">#[error(not(source))] </span>String),
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Return `BadRequest` for `MultipartError`
|
||||
</span><span class="kw">impl </span>ResponseError <span class="kw">for </span>MultipartError {
|
||||
<span class="kw">fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
<span class="kw">match </span><span class="kw-2">&</span><span class="self">self </span>{
|
||||
MultipartError::Field { source, .. } => source.as_response_error().status_code(),
|
||||
<span class="kw">_ </span>=> StatusCode::BAD_REQUEST,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="attr">#[test]
|
||||
</span><span class="kw">fn </span>test_multipart_error() {
|
||||
<span class="kw">let </span>resp = MultipartError::Boundary.error_response();
|
||||
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::BAD_REQUEST);
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
87
src/actix_multipart/extractor.rs.html
Normal file
87
src/actix_multipart/extractor.rs.html
Normal file
@ -0,0 +1,87 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/extractor.rs`."><title>extractor.rs - source</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="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Multipart payload support
|
||||
|
||||
</span><span class="kw">use </span>actix_utils::future::{ready, Ready};
|
||||
<span class="kw">use </span>actix_web::{dev::Payload, Error, FromRequest, HttpRequest};
|
||||
|
||||
<span class="kw">use </span><span class="kw">crate</span>::server::Multipart;
|
||||
|
||||
<span class="doccomment">/// Get request's payload as multipart stream.
|
||||
///
|
||||
/// Content-type: multipart/form-data;
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use actix_web::{web, HttpResponse, Error};
|
||||
/// use actix_multipart::Multipart;
|
||||
/// use futures_util::StreamExt as _;
|
||||
///
|
||||
/// async fn index(mut payload: Multipart) -> Result<HttpResponse, Error> {
|
||||
/// // iterate over multipart stream
|
||||
/// while let Some(item) = payload.next().await {
|
||||
/// let mut field = item?;
|
||||
///
|
||||
/// // Field in turn is stream of *Bytes* object
|
||||
/// while let Some(chunk) = field.next().await {
|
||||
/// println!("-- CHUNK: \n{:?}", std::str::from_utf8(&chunk?));
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// Ok(HttpResponse::Ok().into())
|
||||
/// }
|
||||
/// ```
|
||||
</span><span class="kw">impl </span>FromRequest <span class="kw">for </span>Multipart {
|
||||
<span class="kw">type </span>Error = Error;
|
||||
<span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><Multipart, Error>>;
|
||||
|
||||
<span class="attr">#[inline]
|
||||
</span><span class="kw">fn </span>from_request(req: <span class="kw-2">&</span>HttpRequest, payload: <span class="kw-2">&mut </span>Payload) -> <span class="self">Self</span>::Future {
|
||||
ready(<span class="prelude-val">Ok</span>(<span class="kw">match </span>Multipart::boundary(req.headers()) {
|
||||
<span class="prelude-val">Ok</span>(boundary) => Multipart::from_boundary(boundary, payload.take()),
|
||||
<span class="prelude-val">Err</span>(err) => Multipart::from_error(err),
|
||||
}))
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
99
src/actix_multipart/form/bytes.rs.html
Normal file
99
src/actix_multipart/form/bytes.rs.html
Normal file
@ -0,0 +1,99 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/form/bytes.rs`."><title>bytes.rs - source</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="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Reads a field into memory.
|
||||
|
||||
</span><span class="kw">use </span>actix_web::HttpRequest;
|
||||
<span class="kw">use </span>bytes::BytesMut;
|
||||
<span class="kw">use </span>futures_core::future::LocalBoxFuture;
|
||||
<span class="kw">use </span>futures_util::TryStreamExt <span class="kw">as _</span>;
|
||||
<span class="kw">use </span>mime::Mime;
|
||||
|
||||
<span class="kw">use crate</span>::{
|
||||
form::{FieldReader, Limits},
|
||||
Field, MultipartError,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// Read the field into memory.
|
||||
</span><span class="attr">#[derive(Debug)]
|
||||
</span><span class="kw">pub struct </span>Bytes {
|
||||
<span class="doccomment">/// The data.
|
||||
</span><span class="kw">pub </span>data: bytes::Bytes,
|
||||
|
||||
<span class="doccomment">/// The value of the `Content-Type` header.
|
||||
</span><span class="kw">pub </span>content_type: <span class="prelude-ty">Option</span><Mime>,
|
||||
|
||||
<span class="doccomment">/// The `filename` value in the `Content-Disposition` header.
|
||||
</span><span class="kw">pub </span>file_name: <span class="prelude-ty">Option</span><String>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><<span class="lifetime">'t</span>> FieldReader<<span class="lifetime">'t</span>> <span class="kw">for </span>Bytes {
|
||||
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'t</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>, MultipartError>>;
|
||||
|
||||
<span class="kw">fn </span>read_field(<span class="kw">_</span>: <span class="kw-2">&</span><span class="lifetime">'t </span>HttpRequest, <span class="kw-2">mut </span>field: Field, limits: <span class="kw-2">&</span><span class="lifetime">'t </span><span class="kw-2">mut </span>Limits) -> <span class="self">Self</span>::Future {
|
||||
Box::pin(<span class="kw">async move </span>{
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::with_capacity(<span class="number">131_072</span>);
|
||||
|
||||
<span class="kw">while let </span><span class="prelude-val">Some</span>(chunk) = field.try_next().<span class="kw">await</span><span class="question-mark">? </span>{
|
||||
limits.try_consume_limits(chunk.len(), <span class="bool-val">true</span>)<span class="question-mark">?</span>;
|
||||
buf.extend(chunk);
|
||||
}
|
||||
|
||||
<span class="prelude-val">Ok</span>(Bytes {
|
||||
data: buf.freeze(),
|
||||
content_type: field.content_type().map(ToOwned::to_owned),
|
||||
file_name: field
|
||||
.content_disposition()
|
||||
.get_filename()
|
||||
.map(str::to_owned),
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
423
src/actix_multipart/form/json.rs.html
Normal file
423
src/actix_multipart/form/json.rs.html
Normal file
@ -0,0 +1,423 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/form/json.rs`."><title>json.rs - source</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="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
<a href="#62" id="62">62</a>
|
||||
<a href="#63" id="63">63</a>
|
||||
<a href="#64" id="64">64</a>
|
||||
<a href="#65" id="65">65</a>
|
||||
<a href="#66" id="66">66</a>
|
||||
<a href="#67" id="67">67</a>
|
||||
<a href="#68" id="68">68</a>
|
||||
<a href="#69" id="69">69</a>
|
||||
<a href="#70" id="70">70</a>
|
||||
<a href="#71" id="71">71</a>
|
||||
<a href="#72" id="72">72</a>
|
||||
<a href="#73" id="73">73</a>
|
||||
<a href="#74" id="74">74</a>
|
||||
<a href="#75" id="75">75</a>
|
||||
<a href="#76" id="76">76</a>
|
||||
<a href="#77" id="77">77</a>
|
||||
<a href="#78" id="78">78</a>
|
||||
<a href="#79" id="79">79</a>
|
||||
<a href="#80" id="80">80</a>
|
||||
<a href="#81" id="81">81</a>
|
||||
<a href="#82" id="82">82</a>
|
||||
<a href="#83" id="83">83</a>
|
||||
<a href="#84" id="84">84</a>
|
||||
<a href="#85" id="85">85</a>
|
||||
<a href="#86" id="86">86</a>
|
||||
<a href="#87" id="87">87</a>
|
||||
<a href="#88" id="88">88</a>
|
||||
<a href="#89" id="89">89</a>
|
||||
<a href="#90" id="90">90</a>
|
||||
<a href="#91" id="91">91</a>
|
||||
<a href="#92" id="92">92</a>
|
||||
<a href="#93" id="93">93</a>
|
||||
<a href="#94" id="94">94</a>
|
||||
<a href="#95" id="95">95</a>
|
||||
<a href="#96" id="96">96</a>
|
||||
<a href="#97" id="97">97</a>
|
||||
<a href="#98" id="98">98</a>
|
||||
<a href="#99" id="99">99</a>
|
||||
<a href="#100" id="100">100</a>
|
||||
<a href="#101" id="101">101</a>
|
||||
<a href="#102" id="102">102</a>
|
||||
<a href="#103" id="103">103</a>
|
||||
<a href="#104" id="104">104</a>
|
||||
<a href="#105" id="105">105</a>
|
||||
<a href="#106" id="106">106</a>
|
||||
<a href="#107" id="107">107</a>
|
||||
<a href="#108" id="108">108</a>
|
||||
<a href="#109" id="109">109</a>
|
||||
<a href="#110" id="110">110</a>
|
||||
<a href="#111" id="111">111</a>
|
||||
<a href="#112" id="112">112</a>
|
||||
<a href="#113" id="113">113</a>
|
||||
<a href="#114" id="114">114</a>
|
||||
<a href="#115" id="115">115</a>
|
||||
<a href="#116" id="116">116</a>
|
||||
<a href="#117" id="117">117</a>
|
||||
<a href="#118" id="118">118</a>
|
||||
<a href="#119" id="119">119</a>
|
||||
<a href="#120" id="120">120</a>
|
||||
<a href="#121" id="121">121</a>
|
||||
<a href="#122" id="122">122</a>
|
||||
<a href="#123" id="123">123</a>
|
||||
<a href="#124" id="124">124</a>
|
||||
<a href="#125" id="125">125</a>
|
||||
<a href="#126" id="126">126</a>
|
||||
<a href="#127" id="127">127</a>
|
||||
<a href="#128" id="128">128</a>
|
||||
<a href="#129" id="129">129</a>
|
||||
<a href="#130" id="130">130</a>
|
||||
<a href="#131" id="131">131</a>
|
||||
<a href="#132" id="132">132</a>
|
||||
<a href="#133" id="133">133</a>
|
||||
<a href="#134" id="134">134</a>
|
||||
<a href="#135" id="135">135</a>
|
||||
<a href="#136" id="136">136</a>
|
||||
<a href="#137" id="137">137</a>
|
||||
<a href="#138" id="138">138</a>
|
||||
<a href="#139" id="139">139</a>
|
||||
<a href="#140" id="140">140</a>
|
||||
<a href="#141" id="141">141</a>
|
||||
<a href="#142" id="142">142</a>
|
||||
<a href="#143" id="143">143</a>
|
||||
<a href="#144" id="144">144</a>
|
||||
<a href="#145" id="145">145</a>
|
||||
<a href="#146" id="146">146</a>
|
||||
<a href="#147" id="147">147</a>
|
||||
<a href="#148" id="148">148</a>
|
||||
<a href="#149" id="149">149</a>
|
||||
<a href="#150" id="150">150</a>
|
||||
<a href="#151" id="151">151</a>
|
||||
<a href="#152" id="152">152</a>
|
||||
<a href="#153" id="153">153</a>
|
||||
<a href="#154" id="154">154</a>
|
||||
<a href="#155" id="155">155</a>
|
||||
<a href="#156" id="156">156</a>
|
||||
<a href="#157" id="157">157</a>
|
||||
<a href="#158" id="158">158</a>
|
||||
<a href="#159" id="159">159</a>
|
||||
<a href="#160" id="160">160</a>
|
||||
<a href="#161" id="161">161</a>
|
||||
<a href="#162" id="162">162</a>
|
||||
<a href="#163" id="163">163</a>
|
||||
<a href="#164" id="164">164</a>
|
||||
<a href="#165" id="165">165</a>
|
||||
<a href="#166" id="166">166</a>
|
||||
<a href="#167" id="167">167</a>
|
||||
<a href="#168" id="168">168</a>
|
||||
<a href="#169" id="169">169</a>
|
||||
<a href="#170" id="170">170</a>
|
||||
<a href="#171" id="171">171</a>
|
||||
<a href="#172" id="172">172</a>
|
||||
<a href="#173" id="173">173</a>
|
||||
<a href="#174" id="174">174</a>
|
||||
<a href="#175" id="175">175</a>
|
||||
<a href="#176" id="176">176</a>
|
||||
<a href="#177" id="177">177</a>
|
||||
<a href="#178" id="178">178</a>
|
||||
<a href="#179" id="179">179</a>
|
||||
<a href="#180" id="180">180</a>
|
||||
<a href="#181" id="181">181</a>
|
||||
<a href="#182" id="182">182</a>
|
||||
<a href="#183" id="183">183</a>
|
||||
<a href="#184" id="184">184</a>
|
||||
<a href="#185" id="185">185</a>
|
||||
<a href="#186" id="186">186</a>
|
||||
<a href="#187" id="187">187</a>
|
||||
<a href="#188" id="188">188</a>
|
||||
<a href="#189" id="189">189</a>
|
||||
<a href="#190" id="190">190</a>
|
||||
<a href="#191" id="191">191</a>
|
||||
<a href="#192" id="192">192</a>
|
||||
<a href="#193" id="193">193</a>
|
||||
<a href="#194" id="194">194</a>
|
||||
<a href="#195" id="195">195</a>
|
||||
<a href="#196" id="196">196</a>
|
||||
<a href="#197" id="197">197</a>
|
||||
<a href="#198" id="198">198</a>
|
||||
<a href="#199" id="199">199</a>
|
||||
<a href="#200" id="200">200</a>
|
||||
<a href="#201" id="201">201</a>
|
||||
<a href="#202" id="202">202</a>
|
||||
<a href="#203" id="203">203</a>
|
||||
<a href="#204" id="204">204</a>
|
||||
<a href="#205" id="205">205</a>
|
||||
<a href="#206" id="206">206</a>
|
||||
<a href="#207" id="207">207</a>
|
||||
<a href="#208" id="208">208</a>
|
||||
<a href="#209" id="209">209</a>
|
||||
<a href="#210" id="210">210</a>
|
||||
<a href="#211" id="211">211</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Deserializes a field as JSON.
|
||||
|
||||
</span><span class="kw">use </span>std::sync::Arc;
|
||||
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, Error, HttpRequest, ResponseError};
|
||||
<span class="kw">use </span>derive_more::{Deref, DerefMut, Display, Error};
|
||||
<span class="kw">use </span>futures_core::future::LocalBoxFuture;
|
||||
<span class="kw">use </span>serde::de::DeserializeOwned;
|
||||
|
||||
<span class="kw">use </span><span class="kw">super</span>::FieldErrorHandler;
|
||||
<span class="kw">use crate</span>::{
|
||||
form::{bytes::Bytes, FieldReader, Limits},
|
||||
Field, MultipartError,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// Deserialize from JSON.
|
||||
</span><span class="attr">#[derive(Debug, Deref, DerefMut)]
|
||||
</span><span class="kw">pub struct </span>Json<T: DeserializeOwned>(<span class="kw">pub </span>T);
|
||||
|
||||
<span class="kw">impl</span><T: DeserializeOwned> Json<T> {
|
||||
<span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> T {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><<span class="lifetime">'t</span>, T> FieldReader<<span class="lifetime">'t</span>> <span class="kw">for </span>Json<T>
|
||||
<span class="kw">where
|
||||
</span>T: DeserializeOwned + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'t</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>, MultipartError>>;
|
||||
|
||||
<span class="kw">fn </span>read_field(req: <span class="kw-2">&</span><span class="lifetime">'t </span>HttpRequest, field: Field, limits: <span class="kw-2">&</span><span class="lifetime">'t </span><span class="kw-2">mut </span>Limits) -> <span class="self">Self</span>::Future {
|
||||
Box::pin(<span class="kw">async move </span>{
|
||||
<span class="kw">let </span>config = JsonConfig::from_req(req);
|
||||
<span class="kw">let </span>field_name = field.name().to_owned();
|
||||
|
||||
<span class="kw">if </span>config.validate_content_type {
|
||||
<span class="kw">let </span>valid = <span class="kw">if let </span><span class="prelude-val">Some</span>(mime) = field.content_type() {
|
||||
mime.subtype() == mime::JSON || mime.suffix() == <span class="prelude-val">Some</span>(mime::JSON)
|
||||
} <span class="kw">else </span>{
|
||||
<span class="bool-val">false
|
||||
</span>};
|
||||
|
||||
<span class="kw">if </span>!valid {
|
||||
<span class="kw">return </span><span class="prelude-val">Err</span>(MultipartError::Field {
|
||||
field_name,
|
||||
source: config.map_error(req, JsonFieldError::ContentType),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">let </span>bytes = Bytes::read_field(req, field, limits).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(Json(serde_json::from_slice(bytes.data.as_ref()).map_err(
|
||||
|err| MultipartError::Field {
|
||||
field_name,
|
||||
source: config.map_error(req, JsonFieldError::Deserialize(err)),
|
||||
},
|
||||
)<span class="question-mark">?</span>))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[derive(Debug, Display, Error)]
|
||||
#[non_exhaustive]
|
||||
</span><span class="kw">pub enum </span>JsonFieldError {
|
||||
<span class="doccomment">/// Deserialize error.
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Json deserialize error: {}"</span>, _0)]
|
||||
</span>Deserialize(serde_json::Error),
|
||||
|
||||
<span class="doccomment">/// Content type error.
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Content type error"</span>)]
|
||||
</span>ContentType,
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>ResponseError <span class="kw">for </span>JsonFieldError {
|
||||
<span class="kw">fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
StatusCode::BAD_REQUEST
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Configuration for the [`Json`] field reader.
|
||||
</span><span class="attr">#[derive(Clone)]
|
||||
</span><span class="kw">pub struct </span>JsonConfig {
|
||||
err_handler: FieldErrorHandler<JsonFieldError>,
|
||||
validate_content_type: bool,
|
||||
}
|
||||
|
||||
<span class="kw">const </span>DEFAULT_CONFIG: JsonConfig = JsonConfig {
|
||||
err_handler: <span class="prelude-val">None</span>,
|
||||
validate_content_type: <span class="bool-val">true</span>,
|
||||
};
|
||||
|
||||
<span class="kw">impl </span>JsonConfig {
|
||||
<span class="kw">pub fn </span>error_handler<F>(<span class="kw-2">mut </span><span class="self">self</span>, f: F) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>F: Fn(JsonFieldError, <span class="kw-2">&</span>HttpRequest) -> Error + Send + Sync + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="self">self</span>.err_handler = <span class="prelude-val">Some</span>(Arc::new(f));
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Extract payload config from app data. Check both `T` and `Data<T>`, in that order, and fall
|
||||
/// back to the default payload config.
|
||||
</span><span class="kw">fn </span>from_req(req: <span class="kw-2">&</span>HttpRequest) -> <span class="kw-2">&</span><span class="self">Self </span>{
|
||||
req.app_data::<<span class="self">Self</span>>()
|
||||
.or_else(|| req.app_data::<web::Data<<span class="self">Self</span>>>().map(|d| d.as_ref()))
|
||||
.unwrap_or(<span class="kw-2">&</span>DEFAULT_CONFIG)
|
||||
}
|
||||
|
||||
<span class="kw">fn </span>map_error(<span class="kw-2">&</span><span class="self">self</span>, req: <span class="kw-2">&</span>HttpRequest, err: JsonFieldError) -> Error {
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(err_handler) = <span class="self">self</span>.err_handler.as_ref() {
|
||||
(<span class="kw-2">*</span>err_handler)(err, req)
|
||||
} <span class="kw">else </span>{
|
||||
err.into()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets whether or not the field must have a valid `Content-Type` header to be parsed.
|
||||
</span><span class="kw">pub fn </span>validate_content_type(<span class="kw-2">mut </span><span class="self">self</span>, validate_content_type: bool) -> <span class="self">Self </span>{
|
||||
<span class="self">self</span>.validate_content_type = validate_content_type;
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>Default <span class="kw">for </span>JsonConfig {
|
||||
<span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
||||
DEFAULT_CONFIG
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>std::collections::HashMap;
|
||||
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, App, HttpResponse, Responder};
|
||||
<span class="kw">use </span>bytes::Bytes;
|
||||
|
||||
<span class="kw">use </span><span class="kw">crate</span>::form::{
|
||||
json::{Json, JsonConfig},
|
||||
MultipartForm,
|
||||
};
|
||||
|
||||
<span class="attr">#[derive(MultipartForm)]
|
||||
</span><span class="kw">struct </span>JsonForm {
|
||||
json: Json<HashMap<String, String>>,
|
||||
}
|
||||
|
||||
<span class="kw">async fn </span>test_json_route(form: MultipartForm<JsonForm>) -> <span class="kw">impl </span>Responder {
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>expected = HashMap::new();
|
||||
expected.insert(<span class="string">"key1"</span>.to_owned(), <span class="string">"value1"</span>.to_owned());
|
||||
expected.insert(<span class="string">"key2"</span>.to_owned(), <span class="string">"value2"</span>.to_owned());
|
||||
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>form.json, <span class="kw-2">&</span>expected);
|
||||
HttpResponse::Ok().finish()
|
||||
}
|
||||
|
||||
<span class="kw">const </span>TEST_JSON: <span class="kw-2">&</span>str = <span class="string">r#"{"key1": "value1", "key2": "value2"}"#</span>;
|
||||
|
||||
<span class="attr">#[actix_rt::test]
|
||||
</span><span class="kw">async fn </span>test_json_without_content_type() {
|
||||
<span class="kw">let </span>srv = actix_test::start(|| {
|
||||
App::new()
|
||||
.route(<span class="string">"/"</span>, web::post().to(test_json_route))
|
||||
.app_data(JsonConfig::default().validate_content_type(<span class="bool-val">false</span>))
|
||||
});
|
||||
|
||||
<span class="kw">let </span>(body, headers) = <span class="kw">crate</span>::test::create_form_data_payload_and_headers(
|
||||
<span class="string">"json"</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
Bytes::from_static(TEST_JSON.as_bytes()),
|
||||
);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>req = srv.post(<span class="string">"/"</span>);
|
||||
<span class="kw-2">*</span>req.headers_mut() = headers;
|
||||
<span class="kw">let </span>res = req.send_body(body).<span class="kw">await</span>.unwrap();
|
||||
<span class="macro">assert_eq!</span>(res.status(), StatusCode::OK);
|
||||
}
|
||||
|
||||
<span class="attr">#[actix_rt::test]
|
||||
</span><span class="kw">async fn </span>test_content_type_validation() {
|
||||
<span class="kw">let </span>srv = actix_test::start(|| {
|
||||
App::new()
|
||||
.route(<span class="string">"/"</span>, web::post().to(test_json_route))
|
||||
.app_data(JsonConfig::default().validate_content_type(<span class="bool-val">true</span>))
|
||||
});
|
||||
|
||||
<span class="comment">// Deny because wrong content type
|
||||
</span><span class="kw">let </span>(body, headers) = <span class="kw">crate</span>::test::create_form_data_payload_and_headers(
|
||||
<span class="string">"json"</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">Some</span>(mime::APPLICATION_OCTET_STREAM),
|
||||
Bytes::from_static(TEST_JSON.as_bytes()),
|
||||
);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>req = srv.post(<span class="string">"/"</span>);
|
||||
<span class="kw-2">*</span>req.headers_mut() = headers;
|
||||
<span class="kw">let </span>res = req.send_body(body).<span class="kw">await</span>.unwrap();
|
||||
<span class="macro">assert_eq!</span>(res.status(), StatusCode::BAD_REQUEST);
|
||||
|
||||
<span class="comment">// Allow because correct content type
|
||||
</span><span class="kw">let </span>(body, headers) = <span class="kw">crate</span>::test::create_form_data_payload_and_headers(
|
||||
<span class="string">"json"</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">Some</span>(mime::APPLICATION_JSON),
|
||||
Bytes::from_static(TEST_JSON.as_bytes()),
|
||||
);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>req = srv.post(<span class="string">"/"</span>);
|
||||
<span class="kw-2">*</span>req.headers_mut() = headers;
|
||||
<span class="kw">let </span>res = req.send_body(body).<span class="kw">await</span>.unwrap();
|
||||
<span class="macro">assert_eq!</span>(res.status(), StatusCode::OK);
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
1475
src/actix_multipart/form/mod.rs.html
Normal file
1475
src/actix_multipart/form/mod.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
399
src/actix_multipart/form/tempfile.rs.html
Normal file
399
src/actix_multipart/form/tempfile.rs.html
Normal file
@ -0,0 +1,399 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/form/tempfile.rs`."><title>tempfile.rs - source</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="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
<a href="#62" id="62">62</a>
|
||||
<a href="#63" id="63">63</a>
|
||||
<a href="#64" id="64">64</a>
|
||||
<a href="#65" id="65">65</a>
|
||||
<a href="#66" id="66">66</a>
|
||||
<a href="#67" id="67">67</a>
|
||||
<a href="#68" id="68">68</a>
|
||||
<a href="#69" id="69">69</a>
|
||||
<a href="#70" id="70">70</a>
|
||||
<a href="#71" id="71">71</a>
|
||||
<a href="#72" id="72">72</a>
|
||||
<a href="#73" id="73">73</a>
|
||||
<a href="#74" id="74">74</a>
|
||||
<a href="#75" id="75">75</a>
|
||||
<a href="#76" id="76">76</a>
|
||||
<a href="#77" id="77">77</a>
|
||||
<a href="#78" id="78">78</a>
|
||||
<a href="#79" id="79">79</a>
|
||||
<a href="#80" id="80">80</a>
|
||||
<a href="#81" id="81">81</a>
|
||||
<a href="#82" id="82">82</a>
|
||||
<a href="#83" id="83">83</a>
|
||||
<a href="#84" id="84">84</a>
|
||||
<a href="#85" id="85">85</a>
|
||||
<a href="#86" id="86">86</a>
|
||||
<a href="#87" id="87">87</a>
|
||||
<a href="#88" id="88">88</a>
|
||||
<a href="#89" id="89">89</a>
|
||||
<a href="#90" id="90">90</a>
|
||||
<a href="#91" id="91">91</a>
|
||||
<a href="#92" id="92">92</a>
|
||||
<a href="#93" id="93">93</a>
|
||||
<a href="#94" id="94">94</a>
|
||||
<a href="#95" id="95">95</a>
|
||||
<a href="#96" id="96">96</a>
|
||||
<a href="#97" id="97">97</a>
|
||||
<a href="#98" id="98">98</a>
|
||||
<a href="#99" id="99">99</a>
|
||||
<a href="#100" id="100">100</a>
|
||||
<a href="#101" id="101">101</a>
|
||||
<a href="#102" id="102">102</a>
|
||||
<a href="#103" id="103">103</a>
|
||||
<a href="#104" id="104">104</a>
|
||||
<a href="#105" id="105">105</a>
|
||||
<a href="#106" id="106">106</a>
|
||||
<a href="#107" id="107">107</a>
|
||||
<a href="#108" id="108">108</a>
|
||||
<a href="#109" id="109">109</a>
|
||||
<a href="#110" id="110">110</a>
|
||||
<a href="#111" id="111">111</a>
|
||||
<a href="#112" id="112">112</a>
|
||||
<a href="#113" id="113">113</a>
|
||||
<a href="#114" id="114">114</a>
|
||||
<a href="#115" id="115">115</a>
|
||||
<a href="#116" id="116">116</a>
|
||||
<a href="#117" id="117">117</a>
|
||||
<a href="#118" id="118">118</a>
|
||||
<a href="#119" id="119">119</a>
|
||||
<a href="#120" id="120">120</a>
|
||||
<a href="#121" id="121">121</a>
|
||||
<a href="#122" id="122">122</a>
|
||||
<a href="#123" id="123">123</a>
|
||||
<a href="#124" id="124">124</a>
|
||||
<a href="#125" id="125">125</a>
|
||||
<a href="#126" id="126">126</a>
|
||||
<a href="#127" id="127">127</a>
|
||||
<a href="#128" id="128">128</a>
|
||||
<a href="#129" id="129">129</a>
|
||||
<a href="#130" id="130">130</a>
|
||||
<a href="#131" id="131">131</a>
|
||||
<a href="#132" id="132">132</a>
|
||||
<a href="#133" id="133">133</a>
|
||||
<a href="#134" id="134">134</a>
|
||||
<a href="#135" id="135">135</a>
|
||||
<a href="#136" id="136">136</a>
|
||||
<a href="#137" id="137">137</a>
|
||||
<a href="#138" id="138">138</a>
|
||||
<a href="#139" id="139">139</a>
|
||||
<a href="#140" id="140">140</a>
|
||||
<a href="#141" id="141">141</a>
|
||||
<a href="#142" id="142">142</a>
|
||||
<a href="#143" id="143">143</a>
|
||||
<a href="#144" id="144">144</a>
|
||||
<a href="#145" id="145">145</a>
|
||||
<a href="#146" id="146">146</a>
|
||||
<a href="#147" id="147">147</a>
|
||||
<a href="#148" id="148">148</a>
|
||||
<a href="#149" id="149">149</a>
|
||||
<a href="#150" id="150">150</a>
|
||||
<a href="#151" id="151">151</a>
|
||||
<a href="#152" id="152">152</a>
|
||||
<a href="#153" id="153">153</a>
|
||||
<a href="#154" id="154">154</a>
|
||||
<a href="#155" id="155">155</a>
|
||||
<a href="#156" id="156">156</a>
|
||||
<a href="#157" id="157">157</a>
|
||||
<a href="#158" id="158">158</a>
|
||||
<a href="#159" id="159">159</a>
|
||||
<a href="#160" id="160">160</a>
|
||||
<a href="#161" id="161">161</a>
|
||||
<a href="#162" id="162">162</a>
|
||||
<a href="#163" id="163">163</a>
|
||||
<a href="#164" id="164">164</a>
|
||||
<a href="#165" id="165">165</a>
|
||||
<a href="#166" id="166">166</a>
|
||||
<a href="#167" id="167">167</a>
|
||||
<a href="#168" id="168">168</a>
|
||||
<a href="#169" id="169">169</a>
|
||||
<a href="#170" id="170">170</a>
|
||||
<a href="#171" id="171">171</a>
|
||||
<a href="#172" id="172">172</a>
|
||||
<a href="#173" id="173">173</a>
|
||||
<a href="#174" id="174">174</a>
|
||||
<a href="#175" id="175">175</a>
|
||||
<a href="#176" id="176">176</a>
|
||||
<a href="#177" id="177">177</a>
|
||||
<a href="#178" id="178">178</a>
|
||||
<a href="#179" id="179">179</a>
|
||||
<a href="#180" id="180">180</a>
|
||||
<a href="#181" id="181">181</a>
|
||||
<a href="#182" id="182">182</a>
|
||||
<a href="#183" id="183">183</a>
|
||||
<a href="#184" id="184">184</a>
|
||||
<a href="#185" id="185">185</a>
|
||||
<a href="#186" id="186">186</a>
|
||||
<a href="#187" id="187">187</a>
|
||||
<a href="#188" id="188">188</a>
|
||||
<a href="#189" id="189">189</a>
|
||||
<a href="#190" id="190">190</a>
|
||||
<a href="#191" id="191">191</a>
|
||||
<a href="#192" id="192">192</a>
|
||||
<a href="#193" id="193">193</a>
|
||||
<a href="#194" id="194">194</a>
|
||||
<a href="#195" id="195">195</a>
|
||||
<a href="#196" id="196">196</a>
|
||||
<a href="#197" id="197">197</a>
|
||||
<a href="#198" id="198">198</a>
|
||||
<a href="#199" id="199">199</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Writes a field to a temporary file on disk.
|
||||
|
||||
</span><span class="kw">use </span>std::{
|
||||
io,
|
||||
path::{Path, PathBuf},
|
||||
sync::Arc,
|
||||
};
|
||||
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, Error, HttpRequest, ResponseError};
|
||||
<span class="kw">use </span>derive_more::{Display, Error};
|
||||
<span class="kw">use </span>futures_core::future::LocalBoxFuture;
|
||||
<span class="kw">use </span>futures_util::TryStreamExt <span class="kw">as _</span>;
|
||||
<span class="kw">use </span>mime::Mime;
|
||||
<span class="kw">use </span>tempfile::NamedTempFile;
|
||||
<span class="kw">use </span>tokio::io::AsyncWriteExt;
|
||||
|
||||
<span class="kw">use </span><span class="kw">super</span>::FieldErrorHandler;
|
||||
<span class="kw">use crate</span>::{
|
||||
form::{FieldReader, Limits},
|
||||
Field, MultipartError,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// Write the field to a temporary file on disk.
|
||||
</span><span class="attr">#[derive(Debug)]
|
||||
</span><span class="kw">pub struct </span>TempFile {
|
||||
<span class="doccomment">/// The temporary file on disk.
|
||||
</span><span class="kw">pub </span>file: NamedTempFile,
|
||||
|
||||
<span class="doccomment">/// The value of the `content-type` header.
|
||||
</span><span class="kw">pub </span>content_type: <span class="prelude-ty">Option</span><Mime>,
|
||||
|
||||
<span class="doccomment">/// The `filename` value in the `content-disposition` header.
|
||||
</span><span class="kw">pub </span>file_name: <span class="prelude-ty">Option</span><String>,
|
||||
|
||||
<span class="doccomment">/// The size in bytes of the file.
|
||||
</span><span class="kw">pub </span>size: usize,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><<span class="lifetime">'t</span>> FieldReader<<span class="lifetime">'t</span>> <span class="kw">for </span>TempFile {
|
||||
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'t</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>, MultipartError>>;
|
||||
|
||||
<span class="kw">fn </span>read_field(req: <span class="kw-2">&</span><span class="lifetime">'t </span>HttpRequest, <span class="kw-2">mut </span>field: Field, limits: <span class="kw-2">&</span><span class="lifetime">'t </span><span class="kw-2">mut </span>Limits) -> <span class="self">Self</span>::Future {
|
||||
Box::pin(<span class="kw">async move </span>{
|
||||
<span class="kw">let </span>config = TempFileConfig::from_req(req);
|
||||
<span class="kw">let </span>field_name = field.name().to_owned();
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>size = <span class="number">0</span>;
|
||||
|
||||
<span class="kw">let </span>file = config
|
||||
.create_tempfile()
|
||||
.map_err(|err| config.map_error(req, <span class="kw-2">&</span>field_name, TempFileError::FileIo(err)))<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>file_async =
|
||||
tokio::fs::File::from_std(file.reopen().map_err(|err| {
|
||||
config.map_error(req, <span class="kw-2">&</span>field_name, TempFileError::FileIo(err))
|
||||
})<span class="question-mark">?</span>);
|
||||
|
||||
<span class="kw">while let </span><span class="prelude-val">Some</span>(chunk) = field.try_next().<span class="kw">await</span><span class="question-mark">? </span>{
|
||||
limits.try_consume_limits(chunk.len(), <span class="bool-val">false</span>)<span class="question-mark">?</span>;
|
||||
size += chunk.len();
|
||||
file_async.write_all(chunk.as_ref()).<span class="kw">await</span>.map_err(|err| {
|
||||
config.map_error(req, <span class="kw-2">&</span>field_name, TempFileError::FileIo(err))
|
||||
})<span class="question-mark">?</span>;
|
||||
}
|
||||
|
||||
file_async
|
||||
.flush()
|
||||
.<span class="kw">await
|
||||
</span>.map_err(|err| config.map_error(req, <span class="kw-2">&</span>field_name, TempFileError::FileIo(err)))<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(TempFile {
|
||||
file,
|
||||
content_type: field.content_type().map(ToOwned::to_owned),
|
||||
file_name: field
|
||||
.content_disposition()
|
||||
.get_filename()
|
||||
.map(str::to_owned),
|
||||
size,
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[derive(Debug, Display, Error)]
|
||||
#[non_exhaustive]
|
||||
</span><span class="kw">pub enum </span>TempFileError {
|
||||
<span class="doccomment">/// File I/O Error
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"File I/O error: {}"</span>, _0)]
|
||||
</span>FileIo(std::io::Error),
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>ResponseError <span class="kw">for </span>TempFileError {
|
||||
<span class="kw">fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
StatusCode::INTERNAL_SERVER_ERROR
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Configuration for the [`TempFile`] field reader.
|
||||
</span><span class="attr">#[derive(Clone)]
|
||||
</span><span class="kw">pub struct </span>TempFileConfig {
|
||||
err_handler: FieldErrorHandler<TempFileError>,
|
||||
directory: <span class="prelude-ty">Option</span><PathBuf>,
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>TempFileConfig {
|
||||
<span class="kw">fn </span>create_tempfile(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<NamedTempFile> {
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>dir) = <span class="self">self</span>.directory {
|
||||
NamedTempFile::new_in(dir)
|
||||
} <span class="kw">else </span>{
|
||||
NamedTempFile::new()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>TempFileConfig {
|
||||
<span class="doccomment">/// Sets custom error handler.
|
||||
</span><span class="kw">pub fn </span>error_handler<F>(<span class="kw-2">mut </span><span class="self">self</span>, f: F) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>F: Fn(TempFileError, <span class="kw-2">&</span>HttpRequest) -> Error + Send + Sync + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="self">self</span>.err_handler = <span class="prelude-val">Some</span>(Arc::new(f));
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Extracts payload config from app data. Check both `T` and `Data<T>`, in that order, and fall
|
||||
/// back to the default payload config.
|
||||
</span><span class="kw">fn </span>from_req(req: <span class="kw-2">&</span>HttpRequest) -> <span class="kw-2">&</span><span class="self">Self </span>{
|
||||
req.app_data::<<span class="self">Self</span>>()
|
||||
.or_else(|| req.app_data::<web::Data<<span class="self">Self</span>>>().map(|d| d.as_ref()))
|
||||
.unwrap_or(<span class="kw-2">&</span>DEFAULT_CONFIG)
|
||||
}
|
||||
|
||||
<span class="kw">fn </span>map_error(<span class="kw-2">&</span><span class="self">self</span>, req: <span class="kw-2">&</span>HttpRequest, field_name: <span class="kw-2">&</span>str, err: TempFileError) -> MultipartError {
|
||||
<span class="kw">let </span>source = <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>err_handler) = <span class="self">self</span>.err_handler {
|
||||
(err_handler)(err, req)
|
||||
} <span class="kw">else </span>{
|
||||
err.into()
|
||||
};
|
||||
|
||||
MultipartError::Field {
|
||||
field_name: field_name.to_owned(),
|
||||
source,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets the directory that temp files will be created in.
|
||||
///
|
||||
/// The default temporary file location is platform dependent.
|
||||
</span><span class="kw">pub fn </span>directory(<span class="kw-2">mut </span><span class="self">self</span>, dir: <span class="kw">impl </span>AsRef<Path>) -> <span class="self">Self </span>{
|
||||
<span class="self">self</span>.directory = <span class="prelude-val">Some</span>(dir.as_ref().to_owned());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">const </span>DEFAULT_CONFIG: TempFileConfig = TempFileConfig {
|
||||
err_handler: <span class="prelude-val">None</span>,
|
||||
directory: <span class="prelude-val">None</span>,
|
||||
};
|
||||
|
||||
<span class="kw">impl </span>Default <span class="kw">for </span>TempFileConfig {
|
||||
<span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
||||
DEFAULT_CONFIG
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>std::io::{Cursor, Read};
|
||||
|
||||
<span class="kw">use </span>actix_multipart_rfc7578::client::multipart;
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, App, HttpResponse, Responder};
|
||||
|
||||
<span class="kw">use </span><span class="kw">crate</span>::form::{tempfile::TempFile, tests::send_form, MultipartForm};
|
||||
|
||||
<span class="attr">#[derive(MultipartForm)]
|
||||
</span><span class="kw">struct </span>FileForm {
|
||||
file: TempFile,
|
||||
}
|
||||
|
||||
<span class="kw">async fn </span>test_file_route(form: MultipartForm<FileForm>) -> <span class="kw">impl </span>Responder {
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>form = form.into_inner();
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>contents = String::new();
|
||||
form.file.file.read_to_string(<span class="kw-2">&mut </span>contents).unwrap();
|
||||
<span class="macro">assert_eq!</span>(contents, <span class="string">"Hello, world!"</span>);
|
||||
<span class="macro">assert_eq!</span>(form.file.file_name.unwrap(), <span class="string">"testfile.txt"</span>);
|
||||
<span class="macro">assert_eq!</span>(form.file.content_type.unwrap(), mime::TEXT_PLAIN);
|
||||
HttpResponse::Ok().finish()
|
||||
}
|
||||
|
||||
<span class="attr">#[actix_rt::test]
|
||||
</span><span class="kw">async fn </span>test_file_upload() {
|
||||
<span class="kw">let </span>srv = actix_test::start(|| App::new().route(<span class="string">"/"</span>, web::post().to(test_file_route)));
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>form = multipart::Form::default();
|
||||
<span class="kw">let </span>bytes = Cursor::new(<span class="string">"Hello, world!"</span>);
|
||||
form.add_reader_file_with_mime(<span class="string">"file"</span>, bytes, <span class="string">"testfile.txt"</span>, mime::TEXT_PLAIN);
|
||||
<span class="kw">let </span>response = send_form(<span class="kw-2">&</span>srv, form, <span class="string">"/"</span>).<span class="kw">await</span>;
|
||||
<span class="macro">assert_eq!</span>(response.status(), StatusCode::OK);
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
393
src/actix_multipart/form/text.rs.html
Normal file
393
src/actix_multipart/form/text.rs.html
Normal file
@ -0,0 +1,393 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/form/text.rs`."><title>text.rs - source</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="../../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
<a href="#62" id="62">62</a>
|
||||
<a href="#63" id="63">63</a>
|
||||
<a href="#64" id="64">64</a>
|
||||
<a href="#65" id="65">65</a>
|
||||
<a href="#66" id="66">66</a>
|
||||
<a href="#67" id="67">67</a>
|
||||
<a href="#68" id="68">68</a>
|
||||
<a href="#69" id="69">69</a>
|
||||
<a href="#70" id="70">70</a>
|
||||
<a href="#71" id="71">71</a>
|
||||
<a href="#72" id="72">72</a>
|
||||
<a href="#73" id="73">73</a>
|
||||
<a href="#74" id="74">74</a>
|
||||
<a href="#75" id="75">75</a>
|
||||
<a href="#76" id="76">76</a>
|
||||
<a href="#77" id="77">77</a>
|
||||
<a href="#78" id="78">78</a>
|
||||
<a href="#79" id="79">79</a>
|
||||
<a href="#80" id="80">80</a>
|
||||
<a href="#81" id="81">81</a>
|
||||
<a href="#82" id="82">82</a>
|
||||
<a href="#83" id="83">83</a>
|
||||
<a href="#84" id="84">84</a>
|
||||
<a href="#85" id="85">85</a>
|
||||
<a href="#86" id="86">86</a>
|
||||
<a href="#87" id="87">87</a>
|
||||
<a href="#88" id="88">88</a>
|
||||
<a href="#89" id="89">89</a>
|
||||
<a href="#90" id="90">90</a>
|
||||
<a href="#91" id="91">91</a>
|
||||
<a href="#92" id="92">92</a>
|
||||
<a href="#93" id="93">93</a>
|
||||
<a href="#94" id="94">94</a>
|
||||
<a href="#95" id="95">95</a>
|
||||
<a href="#96" id="96">96</a>
|
||||
<a href="#97" id="97">97</a>
|
||||
<a href="#98" id="98">98</a>
|
||||
<a href="#99" id="99">99</a>
|
||||
<a href="#100" id="100">100</a>
|
||||
<a href="#101" id="101">101</a>
|
||||
<a href="#102" id="102">102</a>
|
||||
<a href="#103" id="103">103</a>
|
||||
<a href="#104" id="104">104</a>
|
||||
<a href="#105" id="105">105</a>
|
||||
<a href="#106" id="106">106</a>
|
||||
<a href="#107" id="107">107</a>
|
||||
<a href="#108" id="108">108</a>
|
||||
<a href="#109" id="109">109</a>
|
||||
<a href="#110" id="110">110</a>
|
||||
<a href="#111" id="111">111</a>
|
||||
<a href="#112" id="112">112</a>
|
||||
<a href="#113" id="113">113</a>
|
||||
<a href="#114" id="114">114</a>
|
||||
<a href="#115" id="115">115</a>
|
||||
<a href="#116" id="116">116</a>
|
||||
<a href="#117" id="117">117</a>
|
||||
<a href="#118" id="118">118</a>
|
||||
<a href="#119" id="119">119</a>
|
||||
<a href="#120" id="120">120</a>
|
||||
<a href="#121" id="121">121</a>
|
||||
<a href="#122" id="122">122</a>
|
||||
<a href="#123" id="123">123</a>
|
||||
<a href="#124" id="124">124</a>
|
||||
<a href="#125" id="125">125</a>
|
||||
<a href="#126" id="126">126</a>
|
||||
<a href="#127" id="127">127</a>
|
||||
<a href="#128" id="128">128</a>
|
||||
<a href="#129" id="129">129</a>
|
||||
<a href="#130" id="130">130</a>
|
||||
<a href="#131" id="131">131</a>
|
||||
<a href="#132" id="132">132</a>
|
||||
<a href="#133" id="133">133</a>
|
||||
<a href="#134" id="134">134</a>
|
||||
<a href="#135" id="135">135</a>
|
||||
<a href="#136" id="136">136</a>
|
||||
<a href="#137" id="137">137</a>
|
||||
<a href="#138" id="138">138</a>
|
||||
<a href="#139" id="139">139</a>
|
||||
<a href="#140" id="140">140</a>
|
||||
<a href="#141" id="141">141</a>
|
||||
<a href="#142" id="142">142</a>
|
||||
<a href="#143" id="143">143</a>
|
||||
<a href="#144" id="144">144</a>
|
||||
<a href="#145" id="145">145</a>
|
||||
<a href="#146" id="146">146</a>
|
||||
<a href="#147" id="147">147</a>
|
||||
<a href="#148" id="148">148</a>
|
||||
<a href="#149" id="149">149</a>
|
||||
<a href="#150" id="150">150</a>
|
||||
<a href="#151" id="151">151</a>
|
||||
<a href="#152" id="152">152</a>
|
||||
<a href="#153" id="153">153</a>
|
||||
<a href="#154" id="154">154</a>
|
||||
<a href="#155" id="155">155</a>
|
||||
<a href="#156" id="156">156</a>
|
||||
<a href="#157" id="157">157</a>
|
||||
<a href="#158" id="158">158</a>
|
||||
<a href="#159" id="159">159</a>
|
||||
<a href="#160" id="160">160</a>
|
||||
<a href="#161" id="161">161</a>
|
||||
<a href="#162" id="162">162</a>
|
||||
<a href="#163" id="163">163</a>
|
||||
<a href="#164" id="164">164</a>
|
||||
<a href="#165" id="165">165</a>
|
||||
<a href="#166" id="166">166</a>
|
||||
<a href="#167" id="167">167</a>
|
||||
<a href="#168" id="168">168</a>
|
||||
<a href="#169" id="169">169</a>
|
||||
<a href="#170" id="170">170</a>
|
||||
<a href="#171" id="171">171</a>
|
||||
<a href="#172" id="172">172</a>
|
||||
<a href="#173" id="173">173</a>
|
||||
<a href="#174" id="174">174</a>
|
||||
<a href="#175" id="175">175</a>
|
||||
<a href="#176" id="176">176</a>
|
||||
<a href="#177" id="177">177</a>
|
||||
<a href="#178" id="178">178</a>
|
||||
<a href="#179" id="179">179</a>
|
||||
<a href="#180" id="180">180</a>
|
||||
<a href="#181" id="181">181</a>
|
||||
<a href="#182" id="182">182</a>
|
||||
<a href="#183" id="183">183</a>
|
||||
<a href="#184" id="184">184</a>
|
||||
<a href="#185" id="185">185</a>
|
||||
<a href="#186" id="186">186</a>
|
||||
<a href="#187" id="187">187</a>
|
||||
<a href="#188" id="188">188</a>
|
||||
<a href="#189" id="189">189</a>
|
||||
<a href="#190" id="190">190</a>
|
||||
<a href="#191" id="191">191</a>
|
||||
<a href="#192" id="192">192</a>
|
||||
<a href="#193" id="193">193</a>
|
||||
<a href="#194" id="194">194</a>
|
||||
<a href="#195" id="195">195</a>
|
||||
<a href="#196" id="196">196</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Deserializes a field from plain text.
|
||||
|
||||
</span><span class="kw">use </span>std::{str, sync::Arc};
|
||||
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, Error, HttpRequest, ResponseError};
|
||||
<span class="kw">use </span>derive_more::{Deref, DerefMut, Display, Error};
|
||||
<span class="kw">use </span>futures_core::future::LocalBoxFuture;
|
||||
<span class="kw">use </span>serde::de::DeserializeOwned;
|
||||
|
||||
<span class="kw">use </span><span class="kw">super</span>::FieldErrorHandler;
|
||||
<span class="kw">use crate</span>::{
|
||||
form::{bytes::Bytes, FieldReader, Limits},
|
||||
Field, MultipartError,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// Deserialize from plain text.
|
||||
///
|
||||
/// Internally this uses [`serde_plain`] for deserialization, which supports primitive types
|
||||
/// including strings, numbers, and simple enums.
|
||||
</span><span class="attr">#[derive(Debug, Deref, DerefMut)]
|
||||
</span><span class="kw">pub struct </span>Text<T: DeserializeOwned>(<span class="kw">pub </span>T);
|
||||
|
||||
<span class="kw">impl</span><T: DeserializeOwned> Text<T> {
|
||||
<span class="doccomment">/// Unwraps into inner value.
|
||||
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> T {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><<span class="lifetime">'t</span>, T> FieldReader<<span class="lifetime">'t</span>> <span class="kw">for </span>Text<T>
|
||||
<span class="kw">where
|
||||
</span>T: DeserializeOwned + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'t</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>, MultipartError>>;
|
||||
|
||||
<span class="kw">fn </span>read_field(req: <span class="kw-2">&</span><span class="lifetime">'t </span>HttpRequest, field: Field, limits: <span class="kw-2">&</span><span class="lifetime">'t </span><span class="kw-2">mut </span>Limits) -> <span class="self">Self</span>::Future {
|
||||
Box::pin(<span class="kw">async move </span>{
|
||||
<span class="kw">let </span>config = TextConfig::from_req(req);
|
||||
<span class="kw">let </span>field_name = field.name().to_owned();
|
||||
|
||||
<span class="kw">if </span>config.validate_content_type {
|
||||
<span class="kw">let </span>valid = <span class="kw">if let </span><span class="prelude-val">Some</span>(mime) = field.content_type() {
|
||||
mime.subtype() == mime::PLAIN || mime.suffix() == <span class="prelude-val">Some</span>(mime::PLAIN)
|
||||
} <span class="kw">else </span>{
|
||||
<span class="comment">// https://datatracker.ietf.org/doc/html/rfc7578#section-4.4
|
||||
// content type defaults to text/plain, so None should be considered valid
|
||||
</span><span class="bool-val">true
|
||||
</span>};
|
||||
|
||||
<span class="kw">if </span>!valid {
|
||||
<span class="kw">return </span><span class="prelude-val">Err</span>(MultipartError::Field {
|
||||
field_name,
|
||||
source: config.map_error(req, TextError::ContentType),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">let </span>bytes = Bytes::read_field(req, field, limits).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span>text = str::from_utf8(<span class="kw-2">&</span>bytes.data).map_err(|err| MultipartError::Field {
|
||||
field_name: field_name.clone(),
|
||||
source: config.map_error(req, TextError::Utf8Error(err)),
|
||||
})<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(Text(serde_plain::from_str(text).map_err(|err| {
|
||||
MultipartError::Field {
|
||||
field_name,
|
||||
source: config.map_error(req, TextError::Deserialize(err)),
|
||||
}
|
||||
})<span class="question-mark">?</span>))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[derive(Debug, Display, Error)]
|
||||
#[non_exhaustive]
|
||||
</span><span class="kw">pub enum </span>TextError {
|
||||
<span class="doccomment">/// UTF-8 decoding error.
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"UTF-8 decoding error: {}"</span>, _0)]
|
||||
</span>Utf8Error(str::Utf8Error),
|
||||
|
||||
<span class="doccomment">/// Deserialize error.
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Plain text deserialize error: {}"</span>, _0)]
|
||||
</span>Deserialize(serde_plain::Error),
|
||||
|
||||
<span class="doccomment">/// Content type error.
|
||||
</span><span class="attr">#[display(fmt = <span class="string">"Content type error"</span>)]
|
||||
</span>ContentType,
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>ResponseError <span class="kw">for </span>TextError {
|
||||
<span class="kw">fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
StatusCode::BAD_REQUEST
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Configuration for the [`Text`] field reader.
|
||||
</span><span class="attr">#[derive(Clone)]
|
||||
</span><span class="kw">pub struct </span>TextConfig {
|
||||
err_handler: FieldErrorHandler<TextError>,
|
||||
validate_content_type: bool,
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>TextConfig {
|
||||
<span class="doccomment">/// Sets custom error handler.
|
||||
</span><span class="kw">pub fn </span>error_handler<F>(<span class="kw-2">mut </span><span class="self">self</span>, f: F) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>F: Fn(TextError, <span class="kw-2">&</span>HttpRequest) -> Error + Send + Sync + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="self">self</span>.err_handler = <span class="prelude-val">Some</span>(Arc::new(f));
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Extracts payload config from app data. Check both `T` and `Data<T>`, in that order, and fall
|
||||
/// back to the default payload config.
|
||||
</span><span class="kw">fn </span>from_req(req: <span class="kw-2">&</span>HttpRequest) -> <span class="kw-2">&</span><span class="self">Self </span>{
|
||||
req.app_data::<<span class="self">Self</span>>()
|
||||
.or_else(|| req.app_data::<web::Data<<span class="self">Self</span>>>().map(|d| d.as_ref()))
|
||||
.unwrap_or(<span class="kw-2">&</span>DEFAULT_CONFIG)
|
||||
}
|
||||
|
||||
<span class="kw">fn </span>map_error(<span class="kw-2">&</span><span class="self">self</span>, req: <span class="kw-2">&</span>HttpRequest, err: TextError) -> Error {
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>err_handler) = <span class="self">self</span>.err_handler {
|
||||
(err_handler)(err, req)
|
||||
} <span class="kw">else </span>{
|
||||
err.into()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets whether or not the field must have a valid `Content-Type` header to be parsed.
|
||||
///
|
||||
/// Note that an empty `Content-Type` is also accepted, as the multipart specification defines
|
||||
/// `text/plain` as the default for text fields.
|
||||
</span><span class="kw">pub fn </span>validate_content_type(<span class="kw-2">mut </span><span class="self">self</span>, validate_content_type: bool) -> <span class="self">Self </span>{
|
||||
<span class="self">self</span>.validate_content_type = validate_content_type;
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">const </span>DEFAULT_CONFIG: TextConfig = TextConfig {
|
||||
err_handler: <span class="prelude-val">None</span>,
|
||||
validate_content_type: <span class="bool-val">true</span>,
|
||||
};
|
||||
|
||||
<span class="kw">impl </span>Default <span class="kw">for </span>TextConfig {
|
||||
<span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
||||
DEFAULT_CONFIG
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>std::io::Cursor;
|
||||
|
||||
<span class="kw">use </span>actix_multipart_rfc7578::client::multipart;
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, web, App, HttpResponse, Responder};
|
||||
|
||||
<span class="kw">use </span><span class="kw">crate</span>::form::{
|
||||
tests::send_form,
|
||||
text::{Text, TextConfig},
|
||||
MultipartForm,
|
||||
};
|
||||
|
||||
<span class="attr">#[derive(MultipartForm)]
|
||||
</span><span class="kw">struct </span>TextForm {
|
||||
number: Text<i32>,
|
||||
}
|
||||
|
||||
<span class="kw">async fn </span>test_text_route(form: MultipartForm<TextForm>) -> <span class="kw">impl </span>Responder {
|
||||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>form.number, <span class="number">1025</span>);
|
||||
HttpResponse::Ok().finish()
|
||||
}
|
||||
|
||||
<span class="attr">#[actix_rt::test]
|
||||
</span><span class="kw">async fn </span>test_content_type_validation() {
|
||||
<span class="kw">let </span>srv = actix_test::start(|| {
|
||||
App::new()
|
||||
.route(<span class="string">"/"</span>, web::post().to(test_text_route))
|
||||
.app_data(TextConfig::default().validate_content_type(<span class="bool-val">true</span>))
|
||||
});
|
||||
|
||||
<span class="comment">// Deny because wrong content type
|
||||
</span><span class="kw">let </span>bytes = Cursor::new(<span class="string">"1025"</span>);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>form = multipart::Form::default();
|
||||
form.add_reader_file_with_mime(<span class="string">"number"</span>, bytes, <span class="string">""</span>, mime::APPLICATION_OCTET_STREAM);
|
||||
<span class="kw">let </span>response = send_form(<span class="kw-2">&</span>srv, form, <span class="string">"/"</span>).<span class="kw">await</span>;
|
||||
<span class="macro">assert_eq!</span>(response.status(), StatusCode::BAD_REQUEST);
|
||||
|
||||
<span class="comment">// Allow because correct content type
|
||||
</span><span class="kw">let </span>bytes = Cursor::new(<span class="string">"1025"</span>);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>form = multipart::Form::default();
|
||||
form.add_reader_file_with_mime(<span class="string">"number"</span>, bytes, <span class="string">""</span>, mime::TEXT_PLAIN);
|
||||
<span class="kw">let </span>response = send_form(<span class="kw-2">&</span>srv, form, <span class="string">"/"</span>).<span class="kw">await</span>;
|
||||
<span class="macro">assert_eq!</span>(response.status(), StatusCode::OK);
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
123
src/actix_multipart/lib.rs.html
Normal file
123
src/actix_multipart/lib.rs.html
Normal file
@ -0,0 +1,123 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/lib.rs`."><title>lib.rs - source</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="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
</pre></div><pre class="rust"><code><span class="doccomment">//! Multipart form support for Actix Web.
|
||||
//! # Examples
|
||||
//! ```no_run
|
||||
//! use actix_web::{post, App, HttpServer, Responder};
|
||||
//!
|
||||
//! use actix_multipart::form::{json::Json as MPJson, tempfile::TempFile, MultipartForm};
|
||||
//! use serde::Deserialize;
|
||||
//!
|
||||
//! #[derive(Debug, Deserialize)]
|
||||
//! struct Metadata {
|
||||
//! name: String,
|
||||
//! }
|
||||
//!
|
||||
//! #[derive(Debug, MultipartForm)]
|
||||
//! struct UploadForm {
|
||||
//! #[multipart(limit = "100MB")]
|
||||
//! file: TempFile,
|
||||
//! json: MPJson<Metadata>,
|
||||
//! }
|
||||
//!
|
||||
//! #[post("/videos")]
|
||||
//! pub async fn post_video(MultipartForm(form): MultipartForm<UploadForm>) -> impl Responder {
|
||||
//! format!(
|
||||
//! "Uploaded file {}, with size: {}",
|
||||
//! form.json.name, form.file.size
|
||||
//! )
|
||||
//! }
|
||||
//!
|
||||
//! #[actix_web::main]
|
||||
//! async fn main() -> std::io::Result<()> {
|
||||
//! HttpServer::new(move || App::new().service(post_video))
|
||||
//! .bind(("127.0.0.1", 8080))?
|
||||
//! .run()
|
||||
//! .await
|
||||
//! }
|
||||
//! ```
|
||||
|
||||
</span><span class="attr">#![deny(rust_2018_idioms, nonstandard_style)]
|
||||
#![warn(future_incompatible)]
|
||||
#![allow(clippy::borrow_interior_mutable_const)]
|
||||
#![doc(html_logo_url = <span class="string">"https://actix.rs/img/logo.png"</span>)]
|
||||
#![doc(html_favicon_url = <span class="string">"https://actix.rs/favicon.ico"</span>)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
</span><span class="comment">// This allows us to use the actix_multipart_derive within this crate's tests
|
||||
</span><span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">extern crate </span><span class="self">self </span><span class="kw">as </span>actix_multipart;
|
||||
|
||||
<span class="kw">mod </span>error;
|
||||
<span class="kw">mod </span>extractor;
|
||||
<span class="kw">pub mod </span>form;
|
||||
<span class="kw">mod </span>server;
|
||||
<span class="kw">pub mod </span>test;
|
||||
|
||||
<span class="kw">pub use </span><span class="self">self</span>::{
|
||||
error::MultipartError,
|
||||
server::{Field, Multipart},
|
||||
test::{
|
||||
create_form_data_payload_and_headers, create_form_data_payload_and_headers_with_boundary,
|
||||
},
|
||||
};
|
||||
</code></pre></div></section></main></body></html>
|
||||
2723
src/actix_multipart/server.rs.html
Normal file
2723
src/actix_multipart/server.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
435
src/actix_multipart/test.rs.html
Normal file
435
src/actix_multipart/test.rs.html
Normal file
@ -0,0 +1,435 @@
|
||||
<!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="Source of the Rust file `actix-multipart/src/test.rs`."><title>test.rs - source</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="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||||
<a href="#2" id="2">2</a>
|
||||
<a href="#3" id="3">3</a>
|
||||
<a href="#4" id="4">4</a>
|
||||
<a href="#5" id="5">5</a>
|
||||
<a href="#6" id="6">6</a>
|
||||
<a href="#7" id="7">7</a>
|
||||
<a href="#8" id="8">8</a>
|
||||
<a href="#9" id="9">9</a>
|
||||
<a href="#10" id="10">10</a>
|
||||
<a href="#11" id="11">11</a>
|
||||
<a href="#12" id="12">12</a>
|
||||
<a href="#13" id="13">13</a>
|
||||
<a href="#14" id="14">14</a>
|
||||
<a href="#15" id="15">15</a>
|
||||
<a href="#16" id="16">16</a>
|
||||
<a href="#17" id="17">17</a>
|
||||
<a href="#18" id="18">18</a>
|
||||
<a href="#19" id="19">19</a>
|
||||
<a href="#20" id="20">20</a>
|
||||
<a href="#21" id="21">21</a>
|
||||
<a href="#22" id="22">22</a>
|
||||
<a href="#23" id="23">23</a>
|
||||
<a href="#24" id="24">24</a>
|
||||
<a href="#25" id="25">25</a>
|
||||
<a href="#26" id="26">26</a>
|
||||
<a href="#27" id="27">27</a>
|
||||
<a href="#28" id="28">28</a>
|
||||
<a href="#29" id="29">29</a>
|
||||
<a href="#30" id="30">30</a>
|
||||
<a href="#31" id="31">31</a>
|
||||
<a href="#32" id="32">32</a>
|
||||
<a href="#33" id="33">33</a>
|
||||
<a href="#34" id="34">34</a>
|
||||
<a href="#35" id="35">35</a>
|
||||
<a href="#36" id="36">36</a>
|
||||
<a href="#37" id="37">37</a>
|
||||
<a href="#38" id="38">38</a>
|
||||
<a href="#39" id="39">39</a>
|
||||
<a href="#40" id="40">40</a>
|
||||
<a href="#41" id="41">41</a>
|
||||
<a href="#42" id="42">42</a>
|
||||
<a href="#43" id="43">43</a>
|
||||
<a href="#44" id="44">44</a>
|
||||
<a href="#45" id="45">45</a>
|
||||
<a href="#46" id="46">46</a>
|
||||
<a href="#47" id="47">47</a>
|
||||
<a href="#48" id="48">48</a>
|
||||
<a href="#49" id="49">49</a>
|
||||
<a href="#50" id="50">50</a>
|
||||
<a href="#51" id="51">51</a>
|
||||
<a href="#52" id="52">52</a>
|
||||
<a href="#53" id="53">53</a>
|
||||
<a href="#54" id="54">54</a>
|
||||
<a href="#55" id="55">55</a>
|
||||
<a href="#56" id="56">56</a>
|
||||
<a href="#57" id="57">57</a>
|
||||
<a href="#58" id="58">58</a>
|
||||
<a href="#59" id="59">59</a>
|
||||
<a href="#60" id="60">60</a>
|
||||
<a href="#61" id="61">61</a>
|
||||
<a href="#62" id="62">62</a>
|
||||
<a href="#63" id="63">63</a>
|
||||
<a href="#64" id="64">64</a>
|
||||
<a href="#65" id="65">65</a>
|
||||
<a href="#66" id="66">66</a>
|
||||
<a href="#67" id="67">67</a>
|
||||
<a href="#68" id="68">68</a>
|
||||
<a href="#69" id="69">69</a>
|
||||
<a href="#70" id="70">70</a>
|
||||
<a href="#71" id="71">71</a>
|
||||
<a href="#72" id="72">72</a>
|
||||
<a href="#73" id="73">73</a>
|
||||
<a href="#74" id="74">74</a>
|
||||
<a href="#75" id="75">75</a>
|
||||
<a href="#76" id="76">76</a>
|
||||
<a href="#77" id="77">77</a>
|
||||
<a href="#78" id="78">78</a>
|
||||
<a href="#79" id="79">79</a>
|
||||
<a href="#80" id="80">80</a>
|
||||
<a href="#81" id="81">81</a>
|
||||
<a href="#82" id="82">82</a>
|
||||
<a href="#83" id="83">83</a>
|
||||
<a href="#84" id="84">84</a>
|
||||
<a href="#85" id="85">85</a>
|
||||
<a href="#86" id="86">86</a>
|
||||
<a href="#87" id="87">87</a>
|
||||
<a href="#88" id="88">88</a>
|
||||
<a href="#89" id="89">89</a>
|
||||
<a href="#90" id="90">90</a>
|
||||
<a href="#91" id="91">91</a>
|
||||
<a href="#92" id="92">92</a>
|
||||
<a href="#93" id="93">93</a>
|
||||
<a href="#94" id="94">94</a>
|
||||
<a href="#95" id="95">95</a>
|
||||
<a href="#96" id="96">96</a>
|
||||
<a href="#97" id="97">97</a>
|
||||
<a href="#98" id="98">98</a>
|
||||
<a href="#99" id="99">99</a>
|
||||
<a href="#100" id="100">100</a>
|
||||
<a href="#101" id="101">101</a>
|
||||
<a href="#102" id="102">102</a>
|
||||
<a href="#103" id="103">103</a>
|
||||
<a href="#104" id="104">104</a>
|
||||
<a href="#105" id="105">105</a>
|
||||
<a href="#106" id="106">106</a>
|
||||
<a href="#107" id="107">107</a>
|
||||
<a href="#108" id="108">108</a>
|
||||
<a href="#109" id="109">109</a>
|
||||
<a href="#110" id="110">110</a>
|
||||
<a href="#111" id="111">111</a>
|
||||
<a href="#112" id="112">112</a>
|
||||
<a href="#113" id="113">113</a>
|
||||
<a href="#114" id="114">114</a>
|
||||
<a href="#115" id="115">115</a>
|
||||
<a href="#116" id="116">116</a>
|
||||
<a href="#117" id="117">117</a>
|
||||
<a href="#118" id="118">118</a>
|
||||
<a href="#119" id="119">119</a>
|
||||
<a href="#120" id="120">120</a>
|
||||
<a href="#121" id="121">121</a>
|
||||
<a href="#122" id="122">122</a>
|
||||
<a href="#123" id="123">123</a>
|
||||
<a href="#124" id="124">124</a>
|
||||
<a href="#125" id="125">125</a>
|
||||
<a href="#126" id="126">126</a>
|
||||
<a href="#127" id="127">127</a>
|
||||
<a href="#128" id="128">128</a>
|
||||
<a href="#129" id="129">129</a>
|
||||
<a href="#130" id="130">130</a>
|
||||
<a href="#131" id="131">131</a>
|
||||
<a href="#132" id="132">132</a>
|
||||
<a href="#133" id="133">133</a>
|
||||
<a href="#134" id="134">134</a>
|
||||
<a href="#135" id="135">135</a>
|
||||
<a href="#136" id="136">136</a>
|
||||
<a href="#137" id="137">137</a>
|
||||
<a href="#138" id="138">138</a>
|
||||
<a href="#139" id="139">139</a>
|
||||
<a href="#140" id="140">140</a>
|
||||
<a href="#141" id="141">141</a>
|
||||
<a href="#142" id="142">142</a>
|
||||
<a href="#143" id="143">143</a>
|
||||
<a href="#144" id="144">144</a>
|
||||
<a href="#145" id="145">145</a>
|
||||
<a href="#146" id="146">146</a>
|
||||
<a href="#147" id="147">147</a>
|
||||
<a href="#148" id="148">148</a>
|
||||
<a href="#149" id="149">149</a>
|
||||
<a href="#150" id="150">150</a>
|
||||
<a href="#151" id="151">151</a>
|
||||
<a href="#152" id="152">152</a>
|
||||
<a href="#153" id="153">153</a>
|
||||
<a href="#154" id="154">154</a>
|
||||
<a href="#155" id="155">155</a>
|
||||
<a href="#156" id="156">156</a>
|
||||
<a href="#157" id="157">157</a>
|
||||
<a href="#158" id="158">158</a>
|
||||
<a href="#159" id="159">159</a>
|
||||
<a href="#160" id="160">160</a>
|
||||
<a href="#161" id="161">161</a>
|
||||
<a href="#162" id="162">162</a>
|
||||
<a href="#163" id="163">163</a>
|
||||
<a href="#164" id="164">164</a>
|
||||
<a href="#165" id="165">165</a>
|
||||
<a href="#166" id="166">166</a>
|
||||
<a href="#167" id="167">167</a>
|
||||
<a href="#168" id="168">168</a>
|
||||
<a href="#169" id="169">169</a>
|
||||
<a href="#170" id="170">170</a>
|
||||
<a href="#171" id="171">171</a>
|
||||
<a href="#172" id="172">172</a>
|
||||
<a href="#173" id="173">173</a>
|
||||
<a href="#174" id="174">174</a>
|
||||
<a href="#175" id="175">175</a>
|
||||
<a href="#176" id="176">176</a>
|
||||
<a href="#177" id="177">177</a>
|
||||
<a href="#178" id="178">178</a>
|
||||
<a href="#179" id="179">179</a>
|
||||
<a href="#180" id="180">180</a>
|
||||
<a href="#181" id="181">181</a>
|
||||
<a href="#182" id="182">182</a>
|
||||
<a href="#183" id="183">183</a>
|
||||
<a href="#184" id="184">184</a>
|
||||
<a href="#185" id="185">185</a>
|
||||
<a href="#186" id="186">186</a>
|
||||
<a href="#187" id="187">187</a>
|
||||
<a href="#188" id="188">188</a>
|
||||
<a href="#189" id="189">189</a>
|
||||
<a href="#190" id="190">190</a>
|
||||
<a href="#191" id="191">191</a>
|
||||
<a href="#192" id="192">192</a>
|
||||
<a href="#193" id="193">193</a>
|
||||
<a href="#194" id="194">194</a>
|
||||
<a href="#195" id="195">195</a>
|
||||
<a href="#196" id="196">196</a>
|
||||
<a href="#197" id="197">197</a>
|
||||
<a href="#198" id="198">198</a>
|
||||
<a href="#199" id="199">199</a>
|
||||
<a href="#200" id="200">200</a>
|
||||
<a href="#201" id="201">201</a>
|
||||
<a href="#202" id="202">202</a>
|
||||
<a href="#203" id="203">203</a>
|
||||
<a href="#204" id="204">204</a>
|
||||
<a href="#205" id="205">205</a>
|
||||
<a href="#206" id="206">206</a>
|
||||
<a href="#207" id="207">207</a>
|
||||
<a href="#208" id="208">208</a>
|
||||
<a href="#209" id="209">209</a>
|
||||
<a href="#210" id="210">210</a>
|
||||
<a href="#211" id="211">211</a>
|
||||
<a href="#212" id="212">212</a>
|
||||
<a href="#213" id="213">213</a>
|
||||
<a href="#214" id="214">214</a>
|
||||
<a href="#215" id="215">215</a>
|
||||
<a href="#216" id="216">216</a>
|
||||
<a href="#217" id="217">217</a>
|
||||
</pre></div><pre class="rust"><code><span class="kw">use </span>actix_web::http::header::{<span class="self">self</span>, HeaderMap};
|
||||
<span class="kw">use </span>bytes::{BufMut <span class="kw">as _</span>, Bytes, BytesMut};
|
||||
<span class="kw">use </span>mime::Mime;
|
||||
<span class="kw">use </span>rand::{
|
||||
distributions::{Alphanumeric, DistString <span class="kw">as _</span>},
|
||||
thread_rng,
|
||||
};
|
||||
|
||||
<span class="kw">const </span>CRLF: <span class="kw-2">&</span>[u8] = <span class="string">b"\r\n"</span>;
|
||||
<span class="kw">const </span>CRLF_CRLF: <span class="kw-2">&</span>[u8] = <span class="string">b"\r\n\r\n"</span>;
|
||||
<span class="kw">const </span>HYPHENS: <span class="kw-2">&</span>[u8] = <span class="string">b"--"</span>;
|
||||
<span class="kw">const </span>BOUNDARY_PREFIX: <span class="kw-2">&</span>str = <span class="string">"------------------------"</span>;
|
||||
|
||||
<span class="doccomment">/// Constructs a `multipart/form-data` payload from bytes and metadata.
|
||||
///
|
||||
/// Returned header map can be extended or merged with existing headers.
|
||||
///
|
||||
/// Multipart boundary used is a random alphanumeric string.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use actix_multipart::test::create_form_data_payload_and_headers;
|
||||
/// use actix_web::test::TestRequest;
|
||||
/// use bytes::Bytes;
|
||||
/// use memchr::memmem::find;
|
||||
///
|
||||
/// let (body, headers) = create_form_data_payload_and_headers(
|
||||
/// "foo",
|
||||
/// Some("lorem.txt".to_owned()),
|
||||
/// Some(mime::TEXT_PLAIN_UTF_8),
|
||||
/// Bytes::from_static(b"Lorem ipsum."),
|
||||
/// );
|
||||
///
|
||||
/// assert!(find(&body, b"foo").is_some());
|
||||
/// assert!(find(&body, b"lorem.txt").is_some());
|
||||
/// assert!(find(&body, b"text/plain; charset=utf-8").is_some());
|
||||
/// assert!(find(&body, b"Lorem ipsum.").is_some());
|
||||
///
|
||||
/// let req = TestRequest::default();
|
||||
///
|
||||
/// // merge header map into existing test request and set multipart body
|
||||
/// let req = headers
|
||||
/// .into_iter()
|
||||
/// .fold(req, |req, hdr| req.insert_header(hdr))
|
||||
/// .set_payload(body)
|
||||
/// .to_http_request();
|
||||
///
|
||||
/// assert!(
|
||||
/// req.headers()
|
||||
/// .get("content-type")
|
||||
/// .unwrap()
|
||||
/// .to_str()
|
||||
/// .unwrap()
|
||||
/// .starts_with("multipart/form-data; boundary=\"")
|
||||
/// );
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>create_form_data_payload_and_headers(
|
||||
name: <span class="kw-2">&</span>str,
|
||||
filename: <span class="prelude-ty">Option</span><String>,
|
||||
content_type: <span class="prelude-ty">Option</span><Mime>,
|
||||
file: Bytes,
|
||||
) -> (Bytes, HeaderMap) {
|
||||
<span class="kw">let </span>boundary = Alphanumeric.sample_string(<span class="kw-2">&mut </span>thread_rng(), <span class="number">32</span>);
|
||||
|
||||
create_form_data_payload_and_headers_with_boundary(
|
||||
<span class="kw-2">&</span>boundary,
|
||||
name,
|
||||
filename,
|
||||
content_type,
|
||||
file,
|
||||
)
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Constructs a `multipart/form-data` payload from bytes and metadata with a fixed boundary.
|
||||
///
|
||||
/// See [`create_form_data_payload_and_headers`] for more details.
|
||||
</span><span class="kw">pub fn </span>create_form_data_payload_and_headers_with_boundary(
|
||||
boundary: <span class="kw-2">&</span>str,
|
||||
name: <span class="kw-2">&</span>str,
|
||||
filename: <span class="prelude-ty">Option</span><String>,
|
||||
content_type: <span class="prelude-ty">Option</span><Mime>,
|
||||
file: Bytes,
|
||||
) -> (Bytes, HeaderMap) {
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::with_capacity(file.len() + <span class="number">128</span>);
|
||||
|
||||
<span class="kw">let </span>boundary_str = [BOUNDARY_PREFIX, boundary].concat();
|
||||
<span class="kw">let </span>boundary = boundary_str.as_bytes();
|
||||
|
||||
buf.put(HYPHENS);
|
||||
buf.put(boundary);
|
||||
buf.put(CRLF);
|
||||
|
||||
buf.put(<span class="macro">format!</span>(<span class="string">"Content-Disposition: form-data; name=\"{name}\""</span>).as_bytes());
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(filename) = filename {
|
||||
buf.put(<span class="macro">format!</span>(<span class="string">"; filename=\"{filename}\""</span>).as_bytes());
|
||||
}
|
||||
buf.put(CRLF);
|
||||
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(ct) = content_type {
|
||||
buf.put(<span class="macro">format!</span>(<span class="string">"Content-Type: {ct}"</span>).as_bytes());
|
||||
buf.put(CRLF);
|
||||
}
|
||||
|
||||
buf.put(<span class="macro">format!</span>(<span class="string">"Content-Length: {}"</span>, file.len()).as_bytes());
|
||||
buf.put(CRLF_CRLF);
|
||||
|
||||
buf.put(file);
|
||||
buf.put(CRLF);
|
||||
|
||||
buf.put(HYPHENS);
|
||||
buf.put(boundary);
|
||||
buf.put(HYPHENS);
|
||||
buf.put(CRLF);
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>headers = HeaderMap::new();
|
||||
headers.insert(
|
||||
header::CONTENT_TYPE,
|
||||
<span class="macro">format!</span>(<span class="string">"multipart/form-data; boundary=\"{boundary_str}\""</span>)
|
||||
.parse()
|
||||
.unwrap(),
|
||||
);
|
||||
|
||||
(buf.freeze(), headers)
|
||||
}
|
||||
|
||||
<span class="attr">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>std::convert::Infallible;
|
||||
|
||||
<span class="kw">use </span>futures_util::stream;
|
||||
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="kw">fn </span>find_boundary(headers: <span class="kw-2">&</span>HeaderMap) -> String {
|
||||
headers
|
||||
.get(<span class="string">"content-type"</span>)
|
||||
.unwrap()
|
||||
.to_str()
|
||||
.unwrap()
|
||||
.parse::<mime::Mime>()
|
||||
.unwrap()
|
||||
.get_param(mime::BOUNDARY)
|
||||
.unwrap()
|
||||
.as_str()
|
||||
.to_owned()
|
||||
}
|
||||
|
||||
<span class="attr">#[test]
|
||||
</span><span class="kw">fn </span>wire_format() {
|
||||
<span class="kw">let </span>(pl, headers) = create_form_data_payload_and_headers_with_boundary(
|
||||
<span class="string">"qWeRtYuIoP"</span>,
|
||||
<span class="string">"foo"</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
Bytes::from_static(<span class="string">b"Lorem ipsum dolor\nsit ame."</span>),
|
||||
);
|
||||
|
||||
<span class="macro">assert_eq!</span>(
|
||||
find_boundary(<span class="kw-2">&</span>headers),
|
||||
<span class="string">"------------------------qWeRtYuIoP"</span>,
|
||||
);
|
||||
|
||||
<span class="macro">assert_eq!</span>(
|
||||
std::str::from_utf8(<span class="kw-2">&</span>pl).unwrap(),
|
||||
<span class="string">"--------------------------qWeRtYuIoP\r\n\
|
||||
Content-Disposition: form-data; name=\"foo\"\r\n\
|
||||
Content-Length: 26\r\n\
|
||||
\r\n\
|
||||
Lorem ipsum dolor\n\
|
||||
sit ame.\r\n\
|
||||
--------------------------qWeRtYuIoP--\r\n"</span>,
|
||||
);
|
||||
|
||||
<span class="kw">let </span>(pl, _headers) = create_form_data_payload_and_headers_with_boundary(
|
||||
<span class="string">"qWeRtYuIoP"</span>,
|
||||
<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 dolor\nsit ame."</span>),
|
||||
);
|
||||
|
||||
<span class="macro">assert_eq!</span>(
|
||||
std::str::from_utf8(<span class="kw-2">&</span>pl).unwrap(),
|
||||
<span class="string">"--------------------------qWeRtYuIoP\r\n\
|
||||
Content-Disposition: form-data; name=\"foo\"; filename=\"Lorem.txt\"\r\n\
|
||||
Content-Type: text/plain; charset=utf-8\r\n\
|
||||
Content-Length: 26\r\n\
|
||||
\r\n\
|
||||
Lorem ipsum dolor\n\
|
||||
sit ame.\r\n\
|
||||
--------------------------qWeRtYuIoP--\r\n"</span>,
|
||||
);
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Test using an external library to prevent the two-wrongs-make-a-right class of errors.
|
||||
</span><span class="attr">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>ecosystem_compat() {
|
||||
<span class="kw">let </span>(pl, headers) = create_form_data_payload_and_headers(
|
||||
<span class="string">"foo"</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">None</span>,
|
||||
Bytes::from_static(<span class="string">b"Lorem ipsum dolor\nsit ame."</span>),
|
||||
);
|
||||
|
||||
<span class="kw">let </span>boundary = find_boundary(<span class="kw-2">&</span>headers);
|
||||
|
||||
<span class="kw">let </span>pl = stream::once(<span class="kw">async </span>{ <span class="prelude-val">Ok</span>::<<span class="kw">_</span>, Infallible>(pl) });
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>form = multer::Multipart::new(pl, boundary);
|
||||
<span class="kw">let </span>field = form.next_field().<span class="kw">await</span>.unwrap().unwrap();
|
||||
<span class="macro">assert_eq!</span>(field.name().unwrap(), <span class="string">"foo"</span>);
|
||||
<span class="macro">assert_eq!</span>(field.file_name(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert_eq!</span>(field.content_type(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(field.bytes().<span class="kw">await</span>.unwrap().starts_with(<span class="string">b"Lorem"</span>));
|
||||
}
|
||||
}
|
||||
</code></pre></div></section></main></body></html>
|
||||
Reference in New Issue
Block a user