<!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 `src/errors.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>errors.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../pages/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../pages/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../pages/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><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> <span id="142">142</span> <span id="143">143</span> <span id="144">144</span> <span id="145">145</span> <span id="146">146</span> <span id="147">147</span> <span id="148">148</span> <span id="149">149</span> <span id="150">150</span> <span id="151">151</span> <span id="152">152</span> <span id="153">153</span> <span id="154">154</span> <span id="155">155</span> <span id="156">156</span> <span id="157">157</span> <span id="158">158</span> <span id="159">159</span> <span id="160">160</span> <span id="161">161</span> <span id="162">162</span> <span id="163">163</span> <span id="164">164</span> <span id="165">165</span> <span id="166">166</span> <span id="167">167</span> <span id="168">168</span> <span id="169">169</span> <span id="170">170</span> <span id="171">171</span> <span id="172">172</span> <span id="173">173</span> <span id="174">174</span> <span id="175">175</span> <span id="176">176</span> <span id="177">177</span> <span id="178">178</span> <span id="179">179</span> <span id="180">180</span> <span id="181">181</span> <span id="182">182</span> <span id="183">183</span> <span id="184">184</span> <span id="185">185</span> <span id="186">186</span> <span id="187">187</span> <span id="188">188</span> <span id="189">189</span> <span id="190">190</span> <span id="191">191</span> <span id="192">192</span> <span id="193">193</span> <span id="194">194</span> <span id="195">195</span> <span id="196">196</span> <span id="197">197</span> <span id="198">198</span> <span id="199">199</span> <span id="200">200</span> <span id="201">201</span> <span id="202">202</span> <span id="203">203</span> <span id="204">204</span> <span id="205">205</span> <span id="206">206</span> <span id="207">207</span> <span id="208">208</span> <span id="209">209</span> <span id="210">210</span> <span id="211">211</span> <span id="212">212</span> <span id="213">213</span> <span id="214">214</span> <span id="215">215</span> <span id="216">216</span> <span id="217">217</span> <span id="218">218</span> <span id="219">219</span> <span id="220">220</span> <span id="221">221</span> <span id="222">222</span> <span id="223">223</span> <span id="224">224</span> <span id="225">225</span> <span id="226">226</span> <span id="227">227</span> <span id="228">228</span> <span id="229">229</span> <span id="230">230</span> <span id="231">231</span> <span id="232">232</span> <span id="233">233</span> <span id="234">234</span> <span id="235">235</span> <span id="236">236</span> <span id="237">237</span> <span id="238">238</span> <span id="239">239</span> <span id="240">240</span> <span id="241">241</span> <span id="242">242</span> <span id="243">243</span> <span id="244">244</span> <span id="245">245</span> <span id="246">246</span> <span id="247">247</span> <span id="248">248</span> <span id="249">249</span> <span id="250">250</span> <span id="251">251</span> <span id="252">252</span> <span id="253">253</span> <span id="254">254</span> <span id="255">255</span> <span id="256">256</span> <span id="257">257</span> <span id="258">258</span> <span id="259">259</span> <span id="260">260</span> <span id="261">261</span> <span id="262">262</span> <span id="263">263</span> <span id="264">264</span> <span id="265">265</span> <span id="266">266</span> <span id="267">267</span> </pre><pre class="rust"><code><span class="comment">/* * Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ </span><span class="doccomment">//! Represents all the ways a trait can fail using this crate </span><span class="kw">use </span>std::convert::From; <span class="kw">use </span>std::io::Error <span class="kw">as </span>FSErrorInner; <span class="kw">use </span>std::sync::Arc; <span class="kw">use </span>actix_web::{ error::ResponseError, http::{header, StatusCode}, HttpResponse, HttpResponseBuilder, }; <span class="kw">use </span>argon2_creds::errors::CredsError; <span class="kw">use </span>config::ConfigError <span class="kw">as </span>ConfigErrorInner; <span class="kw">use </span>derive_more::{Display, Error}; <span class="kw">use </span>git2::Error <span class="kw">as </span>GitError; <span class="kw">use </span>serde::{Deserialize, Serialize}; <span class="kw">use </span>url::ParseError; <span class="kw">use </span><span class="kw">crate</span>::page::Page; <span class="attribute">#[derive(Debug, Display, Error)] </span><span class="kw">pub struct </span>FSError(<span class="attribute">#[display(fmt = <span class="string">"File System Error {}"</span>, _0)] </span><span class="kw">pub </span>FSErrorInner); <span class="attribute">#[derive(Debug, Display, Error)] </span><span class="kw">pub struct </span>ConfigError(<span class="attribute">#[display(fmt = <span class="string">"Configuration Error {}"</span>, _0)] </span><span class="kw">pub </span>ConfigErrorInner); <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">impl </span>PartialEq <span class="kw">for </span>FSError { <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { <span class="self">self</span>.<span class="number">0</span>.kind() == other.<span class="number">0</span>.kind() } } <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">impl </span>PartialEq <span class="kw">for </span>ConfigError { <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { <span class="self">self</span>.<span class="number">0</span>.to_string().trim() == other.<span class="number">0</span>.to_string().trim() } } <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">impl </span>From<FSErrorInner> <span class="kw">for </span>ServiceError { <span class="kw">fn </span>from(e: FSErrorInner) -> <span class="self">Self </span>{ <span class="self">Self</span>::FSError(FSError(e)) } } <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">impl </span>From<ConfigErrorInner> <span class="kw">for </span>ServiceError { <span class="kw">fn </span>from(e: ConfigErrorInner) -> <span class="self">Self </span>{ <span class="self">Self</span>::ConfigError(ConfigError(e)) } } <span class="attribute">#[derive(Debug, Display, PartialEq, Error)] #[cfg(not(tarpaulin_include))] </span><span class="doccomment">/// Error data structure grouping various error subtypes </span><span class="kw">pub enum </span>ServiceError { <span class="doccomment">/// All non-specific errors are grouped under this category </span><span class="attribute">#[display(fmt = <span class="string">"internal server error"</span>)] </span>InternalServerError, <span class="attribute">#[display(fmt = <span class="string">"The value you entered for URL is not a URL"</span>)] </span><span class="comment">//405j </span><span class="doccomment">/// The value you entered for url is not url" </span>NotAUrl, <span class="attribute">#[display(fmt = <span class="string">"URL too long, maximum length can't be greater then 2048 characters"</span>)] </span><span class="comment">//405 </span><span class="doccomment">/// URL too long, maximum length can't be greater then 2048 characters </span>URLTooLong, <span class="attribute">#[display(fmt = <span class="string">"Website not found"</span>)] </span><span class="doccomment">/// website not found </span>WebsiteNotFound, <span class="doccomment">/// when the a path configured for a page is already taken </span><span class="attribute">#[display( fmt = <span class="string">"Path already used for another website. lhs: {:?} rhs: {:?}"</span>, _0, _1 )] </span>PathTaken(Arc<Page>, Arc<Page>), <span class="doccomment">/// when the a Secret configured for a page is already taken </span><span class="attribute">#[display( fmt = <span class="string">"Secret already used for another website. lhs: {:?} rhs: {:?}"</span>, _0, _1 )] </span>SecretTaken(Arc<Page>, Arc<Page>), <span class="doccomment">/// when the a Repository URL configured for a page is already taken </span><span class="attribute">#[display( fmt = <span class="string">"Repository URL already configured for another website deployment. lhs: {:?} rhs: {:?}"</span>, _0, _1 )] </span>DuplicateRepositoryURL(Arc<Page>, Arc<Page>), <span class="attribute">#[display(fmt = <span class="string">"File System Error {}"</span>, _0)] </span>FSError(FSError), <span class="attribute">#[display(fmt = <span class="string">"Unauthorized {}"</span>, _0)] </span>UnauthorizedOperation(<span class="attribute">#[error(not(source))] </span>String), <span class="attribute">#[display(fmt = <span class="string">"Bad request: {}"</span>, _0)] </span>BadRequest(<span class="attribute">#[error(not(source))] </span>String), <span class="attribute">#[display(fmt = <span class="string">"Configuration Error {}"</span>, _0)] </span>ConfigError(ConfigError), <span class="attribute">#[display(fmt = <span class="string">"Git Error {}"</span>, _0)] </span>GitError(GitError), <span class="attribute">#[display(fmt = <span class="string">"Branch {} not found"</span>, _0)] </span>BranchNotFound(<span class="attribute">#[error(not(source))] </span>String), <span class="doccomment">/// Username is taken </span><span class="attribute">#[display(fmt = <span class="string">"Username is taken"</span>)] </span>UsernameTaken, <span class="doccomment">/// Email is taken </span><span class="attribute">#[display(fmt = <span class="string">"Email is taken"</span>)] </span>EmailTaken, <span class="doccomment">/// Account not found </span><span class="attribute">#[display(fmt = <span class="string">"Account not found"</span>)] </span>AccountNotFound, <span class="attribute">#[display( fmt = <span class="string">"This server is is closed for registration. Contact admin if this is unexpecter" </span>)] </span><span class="doccomment">/// registration failure, server is is closed for registration </span>ClosedForRegistration, <span class="attribute">#[display(fmt = <span class="string">"The value you entered for email is not an email"</span>)] </span><span class="comment">//405j </span><span class="doccomment">/// The value you entered for email is not an email" </span>NotAnEmail, <span class="attribute">#[display(fmt = <span class="string">"Wrong password"</span>)] </span><span class="doccomment">/// wrong password </span>WrongPassword, <span class="doccomment">/// when the value passed contains profanity </span><span class="attribute">#[display(fmt = <span class="string">"Can't allow profanity in usernames"</span>)] </span>ProfanityError, <span class="doccomment">/// when the value passed contains blacklisted words /// see [blacklist](https://github.com/shuttlecraft/The-Big-Username-Blacklist) </span><span class="attribute">#[display(fmt = <span class="string">"Username contains blacklisted words"</span>)] </span>BlacklistError, <span class="doccomment">/// when the value passed contains characters not present /// in [UsernameCaseMapped](https://tools.ietf.org/html/rfc8265#page-7) /// profile </span><span class="attribute">#[display(fmt = <span class="string">"username_case_mapped violation"</span>)] </span>UsernameCaseMappedError, <span class="attribute">#[display(fmt = <span class="string">"Passsword too short"</span>)] </span><span class="doccomment">/// password too short </span>PasswordTooShort, <span class="attribute">#[display(fmt = <span class="string">"password too long"</span>)] </span><span class="doccomment">/// password too long </span>PasswordTooLong, <span class="attribute">#[display(fmt = <span class="string">"Passwords don't match"</span>)] </span><span class="doccomment">/// passwords don't match </span>PasswordsDontMatch, } <span class="kw">impl </span>From<ParseError> <span class="kw">for </span>ServiceError { <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">fn </span>from(<span class="kw">_</span>: ParseError) -> ServiceError { ServiceError::NotAUrl } } <span class="kw">impl </span>From<GitError> <span class="kw">for </span>ServiceError { <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">fn </span>from(e: GitError) -> ServiceError { ServiceError::GitError(e) } } <span class="doccomment">/// Generic result data structure </span><span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">pub type </span>ServiceResult<V> = std::result::Result<V, ServiceError>; <span class="attribute">#[derive(Serialize, Deserialize, Debug)] #[cfg(not(tarpaulin_include))] </span><span class="kw">pub struct </span>ErrorToResponse { <span class="kw">pub </span>error: String, } <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">impl </span>ResponseError <span class="kw">for </span>ServiceError { <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">fn </span>error_response(<span class="kw-2">&</span><span class="self">self</span>) -> HttpResponse { HttpResponseBuilder::new(<span class="self">self</span>.status_code()) .append_header((header::CONTENT_TYPE, <span class="string">"application/json; charset=UTF-8"</span>)) .body( serde_json::to_string(<span class="kw-2">&</span>ErrorToResponse { error: <span class="self">self</span>.to_string(), }) .unwrap(), ) } <span class="attribute">#[cfg(not(tarpaulin_include))] </span><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="self">self </span>{ ServiceError::InternalServerError => StatusCode::INTERNAL_SERVER_ERROR, <span class="comment">// INTERNAL SERVER ERROR </span>ServiceError::ConfigError(<span class="kw">_</span>) => StatusCode::INTERNAL_SERVER_ERROR, <span class="comment">// INTERNAL SERVER ERROR </span>ServiceError::NotAUrl => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::URLTooLong => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::WebsiteNotFound => StatusCode::NOT_FOUND, <span class="comment">//NOT FOUND, </span>ServiceError::PathTaken(<span class="kw">_</span>, <span class="kw">_</span>) => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::DuplicateRepositoryURL(<span class="kw">_</span>, <span class="kw">_</span>) => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::SecretTaken(<span class="kw">_</span>, <span class="kw">_</span>) => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::FSError(<span class="kw">_</span>) => StatusCode::INTERNAL_SERVER_ERROR, ServiceError::UnauthorizedOperation(<span class="kw">_</span>) => StatusCode::UNAUTHORIZED, ServiceError::BadRequest(<span class="kw">_</span>) => StatusCode::BAD_REQUEST, ServiceError::GitError(<span class="kw">_</span>) => StatusCode::BAD_REQUEST, ServiceError::BranchNotFound(<span class="kw">_</span>) => StatusCode::CONFLICT, ServiceError::EmailTaken => StatusCode::BAD_REQUEST, ServiceError::UsernameTaken => StatusCode::BAD_REQUEST, ServiceError::AccountNotFound => StatusCode::NOT_FOUND, ServiceError::ProfanityError => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::BlacklistError => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::UsernameCaseMappedError => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::PasswordTooShort => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::PasswordTooLong => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::PasswordsDontMatch => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::ClosedForRegistration => StatusCode::FORBIDDEN, <span class="comment">//FORBIDDEN, </span>ServiceError::NotAnEmail => StatusCode::BAD_REQUEST, <span class="comment">//BADREQUEST, </span>ServiceError::WrongPassword => StatusCode::UNAUTHORIZED, <span class="comment">//UNAUTHORIZED, </span>} } } <span class="kw">impl </span>From<CredsError> <span class="kw">for </span>ServiceError { <span class="attribute">#[cfg(not(tarpaulin_include))] </span><span class="kw">fn </span>from(e: CredsError) -> ServiceError { <span class="kw">match </span>e { CredsError::UsernameCaseMappedError => ServiceError::UsernameCaseMappedError, CredsError::ProfainityError => ServiceError::ProfanityError, CredsError::BlacklistError => ServiceError::BlacklistError, CredsError::NotAnEmail => ServiceError::NotAnEmail, CredsError::Argon2Error(<span class="kw">_</span>) => ServiceError::InternalServerError, CredsError::PasswordTooLong => ServiceError::PasswordTooLong, CredsError::PasswordTooShort => ServiceError::PasswordTooShort, } } } </code></pre></div> </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pages" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>