<!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>