<!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 to the Rust file `src/middleware/errhandlers.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>errhandlers.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">HashMap</span>;
<span class="kw">use</span> <span class="ident">error</span>::<span class="prelude-ty">Result</span>;
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">StatusCode</span>;
<span class="kw">use</span> <span class="ident">httprequest</span>::<span class="ident">HttpRequest</span>;
<span class="kw">use</span> <span class="ident">httpresponse</span>::<span class="ident">HttpResponse</span>;
<span class="kw">use</span> <span class="ident">middleware</span>::{<span class="ident">Middleware</span>, <span class="ident">Response</span>};
<span class="kw">type</span> <span class="ident">ErrorHandler</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="op">=</span> <span class="ident">Fn</span>(<span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>, <span class="ident">HttpResponse</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op">></span>;
<span class="doccomment">/// `Middleware` for allowing custom handlers for responses.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// You can use `ErrorHandlers::handler()` method to register a custom error</span>
<span class="doccomment">/// handler for specific status code. You can modify existing response or</span>
<span class="doccomment">/// create completely new one.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # extern crate actix_web;</span>
<span class="doccomment">/// use actix_web::middleware::{ErrorHandlers, Response};</span>
<span class="doccomment">/// use actix_web::{http, App, HttpRequest, HttpResponse, Result};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn render_500<S>(_: &HttpRequest<S>, resp: HttpResponse) -> Result<Response> {</span>
<span class="doccomment">/// let mut builder = resp.into_builder();</span>
<span class="doccomment">/// builder.header(http::header::CONTENT_TYPE, "application/json");</span>
<span class="doccomment">/// Ok(Response::Done(builder.into()))</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn main() {</span>
<span class="doccomment">/// let app = App::new()</span>
<span class="doccomment">/// .middleware(</span>
<span class="doccomment">/// ErrorHandlers::new()</span>
<span class="doccomment">/// .handler(http::StatusCode::INTERNAL_SERVER_ERROR, render_500),</span>
<span class="doccomment">/// )</span>
<span class="doccomment">/// .resource("/test", |r| {</span>
<span class="doccomment">/// r.method(http::Method::GET).f(|_| HttpResponse::Ok());</span>
<span class="doccomment">/// r.method(http::Method::HEAD)</span>
<span class="doccomment">/// .f(|_| HttpResponse::MethodNotAllowed());</span>
<span class="doccomment">/// })</span>
<span class="doccomment">/// .finish();</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ErrorHandlers</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="ident">handlers</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">StatusCode</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">ErrorHandler</span><span class="op"><</span><span class="ident">S</span><span class="op">>></span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ErrorHandlers</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="self">Self</span> {
<span class="ident">ErrorHandlers</span> {
<span class="ident">handlers</span>: <span class="ident">HashMap</span>::<span class="ident">new</span>(),
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">ErrorHandlers</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="doccomment">/// Construct new `ErrorHandlers` instance</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="self">Self</span> {
<span class="ident">ErrorHandlers</span>::<span class="ident">default</span>()
}
<span class="doccomment">/// Register error handler for specified status code</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">handler</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">status</span>: <span class="ident">StatusCode</span>, <span class="ident">handler</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>, <span class="ident">HttpResponse</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
<span class="self">self</span>.<span class="ident">handlers</span>.<span class="ident">insert</span>(<span class="ident">status</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">handler</span>));
<span class="self">self</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="lifetime">'static</span><span class="op">></span> <span class="ident">Middleware</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ErrorHandlers</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">response</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>, <span class="ident">resp</span>: <span class="ident">HttpResponse</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op">></span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">handler</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">handlers</span>.<span class="ident">get</span>(<span class="kw-2">&</span><span class="ident">resp</span>.<span class="ident">status</span>()) {
<span class="ident">handler</span>(<span class="ident">req</span>, <span class="ident">resp</span>)
} <span class="kw">else</span> {
<span class="prelude-val">Ok</span>(<span class="ident">Response</span>::<span class="ident">Done</span>(<span class="ident">resp</span>))
}
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">Error</span>, <span class="ident">ErrorInternalServerError</span>};
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">header</span>::<span class="ident">CONTENT_TYPE</span>;
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">StatusCode</span>;
<span class="kw">use</span> <span class="ident">httpmessage</span>::<span class="ident">HttpMessage</span>;
<span class="kw">use</span> <span class="ident">middleware</span>::<span class="ident">Started</span>;
<span class="kw">use</span> <span class="ident">test</span>::{<span class="self">self</span>, <span class="ident">TestRequest</span>};
<span class="kw">fn</span> <span class="ident">render_500</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="kw">_</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>, <span class="ident">resp</span>: <span class="ident">HttpResponse</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">resp</span>.<span class="ident">into_builder</span>();
<span class="ident">builder</span>.<span class="ident">header</span>(<span class="ident">CONTENT_TYPE</span>, <span class="string">"0001"</span>);
<span class="prelude-val">Ok</span>(<span class="ident">Response</span>::<span class="ident">Done</span>(<span class="ident">builder</span>.<span class="ident">into</span>()))
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_handler</span>() {
<span class="kw">let</span> <span class="ident">mw</span> <span class="op">=</span>
<span class="ident">ErrorHandlers</span>::<span class="ident">new</span>().<span class="ident">handler</span>(<span class="ident">StatusCode</span>::<span class="ident">INTERNAL_SERVER_ERROR</span>, <span class="ident">render_500</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest</span>::<span class="ident">default</span>().<span class="ident">finish</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">HttpResponse</span>::<span class="ident">InternalServerError</span>().<span class="ident">finish</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">mw</span>.<span class="ident">response</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">req</span>, <span class="ident">resp</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">Response</span>::<span class="ident">Done</span>(<span class="ident">resp</span>)) <span class="op">=></span> <span class="ident">resp</span>,
<span class="kw">_</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(),
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">headers</span>().<span class="ident">get</span>(<span class="ident">CONTENT_TYPE</span>).<span class="ident">unwrap</span>(), <span class="string">"0001"</span>);
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">finish</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">mw</span>.<span class="ident">response</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">req</span>, <span class="ident">resp</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">Response</span>::<span class="ident">Done</span>(<span class="ident">resp</span>)) <span class="op">=></span> <span class="ident">resp</span>,
<span class="kw">_</span> <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(),
};
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">resp</span>.<span class="ident">headers</span>().<span class="ident">contains_key</span>(<span class="ident">CONTENT_TYPE</span>));
}
<span class="kw">struct</span> <span class="ident">MiddlewareOne</span>;
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="ident">Middleware</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MiddlewareOne</span> {
<span class="kw">fn</span> <span class="ident">start</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Started</span>, <span class="ident">Error</span><span class="op">></span> {
<span class="prelude-val">Err</span>(<span class="ident">ErrorInternalServerError</span>(<span class="string">"middleware error"</span>))
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_middleware_start_error</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">TestServer</span>::<span class="ident">new</span>(<span class="kw">move</span> <span class="op">|</span><span class="ident">app</span><span class="op">|</span> {
<span class="ident">app</span>.<span class="ident">middleware</span>(
<span class="ident">ErrorHandlers</span>::<span class="ident">new</span>()
.<span class="ident">handler</span>(<span class="ident">StatusCode</span>::<span class="ident">INTERNAL_SERVER_ERROR</span>, <span class="ident">render_500</span>),
).<span class="ident">middleware</span>(<span class="ident">MiddlewareOne</span>)
.<span class="ident">handler</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())
});
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">get</span>().<span class="ident">finish</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">execute</span>(<span class="ident">request</span>.<span class="ident">send</span>()).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">response</span>.<span class="ident">headers</span>().<span class="ident">get</span>(<span class="ident">CONTENT_TYPE</span>).<span class="ident">unwrap</span>(), <span class="string">"0001"</span>);
}
}
</pre>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>