Deploying to gh-pages from @ 5c4435430f 🚀

This commit is contained in:
realaravinth
2021-03-10 16:09:41 +00:00
parent b1860459e0
commit 31c558a9bb
84 changed files with 3467 additions and 145 deletions

View File

@@ -0,0 +1,324 @@
<!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/settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>settings.rs - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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">&#9776;</div><a href='../../tests_migrate/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<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>
<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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">/*
* Copyright (C) 2021 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
*
* 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 &lt;https://www.gnu.org/licenses/&gt;.
*/</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">env</span>;
<span class="kw">use</span> <span class="ident">config</span>::{<span class="ident">Config</span>, <span class="ident">ConfigError</span>, <span class="ident">Environment</span>, <span class="ident">File</span>};
<span class="kw">use</span> <span class="ident">log</span>::<span class="ident">debug</span>;
<span class="kw">use</span> <span class="ident">serde</span>::<span class="ident">Deserialize</span>;
<span class="kw">use</span> <span class="ident">url</span>::<span class="ident">Url</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Server</span> {
<span class="comment">// TODO yet to be configured</span>
<span class="kw">pub</span> <span class="ident">allow_registration</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">port</span>: <span class="ident">u32</span>,
<span class="kw">pub</span> <span class="ident">domain</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">cookie_secret</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">ip</span>: <span class="ident">String</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Captcha</span> {
<span class="kw">pub</span> <span class="ident">salt</span>: <span class="ident">String</span>,
}
<span class="kw">impl</span> <span class="ident">Server</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ip</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">String</span> {
<span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}:{}&quot;</span>, <span class="self">self</span>.<span class="ident">ip</span>, <span class="self">self</span>.<span class="ident">port</span>)
}
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">struct</span> <span class="ident">DatabaseBuilder</span> {
<span class="kw">pub</span> <span class="ident">port</span>: <span class="ident">u32</span>,
<span class="kw">pub</span> <span class="ident">hostname</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">username</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">password</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">name</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">url</span>: <span class="ident">String</span>,
}
<span class="kw">impl</span> <span class="ident">DatabaseBuilder</span> {
<span class="kw">fn</span> <span class="ident">extract_database_url</span>(<span class="ident">url</span>: <span class="kw-2">&amp;</span><span class="ident">Url</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="comment">// if url.scheme() != &quot;postgres&quot; || url.scheme() != &quot;postgresql&quot; {</span>
<span class="comment">// panic!(&quot;URL must be postgres://url, url found: {}&quot;, url.scheme());</span>
<span class="comment">// } else {</span>
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">&quot;Databse name: {}&quot;</span>, <span class="ident">url</span>.<span class="ident">path</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">url</span>.<span class="ident">path</span>().<span class="ident">split</span>(<span class="string">&quot;/&quot;</span>);
<span class="ident">path</span>.<span class="ident">next</span>();
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">path</span>.<span class="ident">next</span>().<span class="ident">expect</span>(<span class="string">&quot;no database name&quot;</span>).<span class="ident">to_string</span>();
<span class="ident">DatabaseBuilder</span> {
<span class="ident">port</span>: <span class="ident">url</span>.<span class="ident">port</span>().<span class="ident">expect</span>(<span class="string">&quot;Enter database port&quot;</span>).<span class="ident">into</span>(),
<span class="ident">hostname</span>: <span class="ident">url</span>.<span class="ident">host</span>().<span class="ident">expect</span>(<span class="string">&quot;Enter database host&quot;</span>).<span class="ident">to_string</span>(),
<span class="ident">username</span>: <span class="ident">url</span>.<span class="ident">username</span>().<span class="ident">into</span>(),
<span class="ident">url</span>: <span class="ident">url</span>.<span class="ident">to_string</span>(),
<span class="ident">password</span>: <span class="ident">url</span>.<span class="ident">password</span>().<span class="ident">expect</span>(<span class="string">&quot;Enter database password&quot;</span>).<span class="ident">into</span>(),
<span class="ident">name</span>,
}
}
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Database</span> {
<span class="kw">pub</span> <span class="ident">url</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">pool</span>: <span class="ident">u32</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Settings</span> {
<span class="kw">pub</span> <span class="ident">debug</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">database</span>: <span class="ident">Database</span>,
<span class="kw">pub</span> <span class="ident">server</span>: <span class="ident">Server</span>,
<span class="kw">pub</span> <span class="ident">pow</span>: <span class="ident">Captcha</span>,
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
<span class="kw">impl</span> <span class="ident">Settings</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">ConfigError</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Config</span>::<span class="ident">new</span>();
<span class="comment">// setting default values</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="ident">s</span>.<span class="ident">set_default</span>(<span class="string">&quot;database.pool&quot;</span>, <span class="number">2</span>.<span class="ident">to_string</span>())
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t get the number of CPUs&quot;</span>);
<span class="comment">// merging default config from file</span>
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File</span>::<span class="ident">with_name</span>(<span class="string">&quot;./config/default.toml&quot;</span>))<span class="question-mark">?</span>;
<span class="comment">// TODO change PLACEHOLDER to app name</span>
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">Environment</span>::<span class="ident">with_prefix</span>(<span class="string">&quot;WEBHUNT&quot;</span>))<span class="question-mark">?</span>;
<span class="kw">match</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">&quot;PORT&quot;</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">&gt;</span> {
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;server.port&quot;</span>, <span class="ident">val</span>).<span class="ident">unwrap</span>();
}
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;couldn&#39;t interpret PORT: {}&quot;</span>, <span class="ident">e</span>),
}
<span class="kw">match</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">&quot;DATABASE_URL&quot;</span>) {
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">url</span> <span class="op">=</span> <span class="ident">Url</span>::<span class="ident">parse</span>(<span class="kw-2">&amp;</span><span class="ident">val</span>).<span class="ident">expect</span>(<span class="string">&quot;couldn&#39;t parse Database URL&quot;</span>);
<span class="kw">let</span> <span class="ident">database_conf</span> <span class="op">=</span> <span class="ident">DatabaseBuilder</span>::<span class="ident">extract_database_url</span>(<span class="kw-2">&amp;</span><span class="ident">url</span>);
<span class="ident">set_from_database_url</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">s</span>, <span class="kw-2">&amp;</span><span class="ident">database_conf</span>);
}
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;couldn&#39;t interpret DATABASE_URL: {}&quot;</span>, <span class="ident">e</span>),
}
<span class="ident">set_database_url</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">s</span>);
<span class="ident">s</span>.<span class="ident">try_into</span>()
}
}
<span class="kw">fn</span> <span class="ident">set_from_database_url</span>(<span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Config</span>, <span class="ident">database_conf</span>: <span class="kw-2">&amp;</span><span class="ident">DatabaseBuilder</span>) {
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;database.username&quot;</span>, <span class="ident">database_conf</span>.<span class="ident">username</span>.<span class="ident">clone</span>())
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t set database username&quot;</span>);
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;database.password&quot;</span>, <span class="ident">database_conf</span>.<span class="ident">password</span>.<span class="ident">clone</span>())
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database password&quot;</span>);
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;database.hostname&quot;</span>, <span class="ident">database_conf</span>.<span class="ident">hostname</span>.<span class="ident">clone</span>())
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database hostname&quot;</span>);
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;database.port&quot;</span>, <span class="ident">database_conf</span>.<span class="ident">port</span> <span class="kw">as</span> <span class="ident">i64</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database port&quot;</span>);
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">&quot;database.name&quot;</span>, <span class="ident">database_conf</span>.<span class="ident">name</span>.<span class="ident">clone</span>())
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database name&quot;</span>);
}
<span class="kw">fn</span> <span class="ident">set_database_url</span>(<span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Config</span>) {
<span class="ident">s</span>.<span class="ident">set</span>(
<span class="string">&quot;database.url&quot;</span>,
<span class="macro">format</span><span class="macro">!</span>(
<span class="string">r&quot;postgres://{}:{}@{}:{}/{}&quot;</span>,
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>(<span class="string">&quot;database.username&quot;</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database username&quot;</span>),
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>(<span class="string">&quot;database.password&quot;</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database password&quot;</span>),
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>(<span class="string">&quot;database.hostname&quot;</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database hostname&quot;</span>),
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>(<span class="string">&quot;database.port&quot;</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database port&quot;</span>),
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>(<span class="string">&quot;database.name&quot;</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t access database name&quot;</span>)
),
)
.<span class="ident">expect</span>(<span class="string">&quot;Couldn&#39;t set databse url&quot;</span>);
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tests_migrate";</script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>