Files
mCaptcha/src/db_core/lib.rs.html

835 lines
42 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `db/db-core/src/lib.rs`."><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ba5701c5741a7b69.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="db_core" data-themes="" data-resource-suffix="" data-rustdoc-version="1.70.0 (90c541806 2023-05-31)" data-search-js="search-e077946657036a58.js" data-settings-js="settings-298e1ea74db45b39.js" data-settings-css="settings-7bfb4c59cc6bc502.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../static.files/source-script-905937fbbdc8e9ea.js"></script><script defer src="../../source-files.js"></script><script defer src="../../static.files/main-f61008743c98d196.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><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>
<a href="#218" id="218">218</a>
<a href="#219" id="219">219</a>
<a href="#220" id="220">220</a>
<a href="#221" id="221">221</a>
<a href="#222" id="222">222</a>
<a href="#223" id="223">223</a>
<a href="#224" id="224">224</a>
<a href="#225" id="225">225</a>
<a href="#226" id="226">226</a>
<a href="#227" id="227">227</a>
<a href="#228" id="228">228</a>
<a href="#229" id="229">229</a>
<a href="#230" id="230">230</a>
<a href="#231" id="231">231</a>
<a href="#232" id="232">232</a>
<a href="#233" id="233">233</a>
<a href="#234" id="234">234</a>
<a href="#235" id="235">235</a>
<a href="#236" id="236">236</a>
<a href="#237" id="237">237</a>
<a href="#238" id="238">238</a>
<a href="#239" id="239">239</a>
<a href="#240" id="240">240</a>
<a href="#241" id="241">241</a>
<a href="#242" id="242">242</a>
<a href="#243" id="243">243</a>
<a href="#244" id="244">244</a>
<a href="#245" id="245">245</a>
<a href="#246" id="246">246</a>
<a href="#247" id="247">247</a>
<a href="#248" id="248">248</a>
<a href="#249" id="249">249</a>
<a href="#250" id="250">250</a>
<a href="#251" id="251">251</a>
<a href="#252" id="252">252</a>
<a href="#253" id="253">253</a>
<a href="#254" id="254">254</a>
<a href="#255" id="255">255</a>
<a href="#256" id="256">256</a>
<a href="#257" id="257">257</a>
<a href="#258" id="258">258</a>
<a href="#259" id="259">259</a>
<a href="#260" id="260">260</a>
<a href="#261" id="261">261</a>
<a href="#262" id="262">262</a>
<a href="#263" id="263">263</a>
<a href="#264" id="264">264</a>
<a href="#265" id="265">265</a>
<a href="#266" id="266">266</a>
<a href="#267" id="267">267</a>
<a href="#268" id="268">268</a>
<a href="#269" id="269">269</a>
<a href="#270" id="270">270</a>
<a href="#271" id="271">271</a>
<a href="#272" id="272">272</a>
<a href="#273" id="273">273</a>
<a href="#274" id="274">274</a>
<a href="#275" id="275">275</a>
<a href="#276" id="276">276</a>
<a href="#277" id="277">277</a>
<a href="#278" id="278">278</a>
<a href="#279" id="279">279</a>
<a href="#280" id="280">280</a>
<a href="#281" id="281">281</a>
<a href="#282" id="282">282</a>
<a href="#283" id="283">283</a>
<a href="#284" id="284">284</a>
<a href="#285" id="285">285</a>
<a href="#286" id="286">286</a>
<a href="#287" id="287">287</a>
<a href="#288" id="288">288</a>
<a href="#289" id="289">289</a>
<a href="#290" id="290">290</a>
<a href="#291" id="291">291</a>
<a href="#292" id="292">292</a>
<a href="#293" id="293">293</a>
<a href="#294" id="294">294</a>
<a href="#295" id="295">295</a>
<a href="#296" id="296">296</a>
<a href="#297" id="297">297</a>
<a href="#298" id="298">298</a>
<a href="#299" id="299">299</a>
<a href="#300" id="300">300</a>
<a href="#301" id="301">301</a>
<a href="#302" id="302">302</a>
<a href="#303" id="303">303</a>
<a href="#304" id="304">304</a>
<a href="#305" id="305">305</a>
<a href="#306" id="306">306</a>
<a href="#307" id="307">307</a>
<a href="#308" id="308">308</a>
<a href="#309" id="309">309</a>
<a href="#310" id="310">310</a>
<a href="#311" id="311">311</a>
<a href="#312" id="312">312</a>
<a href="#313" id="313">313</a>
<a href="#314" id="314">314</a>
<a href="#315" id="315">315</a>
<a href="#316" id="316">316</a>
<a href="#317" id="317">317</a>
<a href="#318" id="318">318</a>
<a href="#319" id="319">319</a>
<a href="#320" id="320">320</a>
<a href="#321" id="321">321</a>
<a href="#322" id="322">322</a>
<a href="#323" id="323">323</a>
<a href="#324" id="324">324</a>
<a href="#325" id="325">325</a>
<a href="#326" id="326">326</a>
<a href="#327" id="327">327</a>
<a href="#328" id="328">328</a>
<a href="#329" id="329">329</a>
<a href="#330" id="330">330</a>
<a href="#331" id="331">331</a>
<a href="#332" id="332">332</a>
<a href="#333" id="333">333</a>
<a href="#334" id="334">334</a>
<a href="#335" id="335">335</a>
<a href="#336" id="336">336</a>
<a href="#337" id="337">337</a>
<a href="#338" id="338">338</a>
<a href="#339" id="339">339</a>
<a href="#340" id="340">340</a>
<a href="#341" id="341">341</a>
<a href="#342" id="342">342</a>
<a href="#343" id="343">343</a>
<a href="#344" id="344">344</a>
<a href="#345" id="345">345</a>
<a href="#346" id="346">346</a>
<a href="#347" id="347">347</a>
<a href="#348" id="348">348</a>
<a href="#349" id="349">349</a>
<a href="#350" id="350">350</a>
<a href="#351" id="351">351</a>
<a href="#352" id="352">352</a>
<a href="#353" id="353">353</a>
<a href="#354" id="354">354</a>
<a href="#355" id="355">355</a>
<a href="#356" id="356">356</a>
<a href="#357" id="357">357</a>
<a href="#358" id="358">358</a>
<a href="#359" id="359">359</a>
<a href="#360" id="360">360</a>
<a href="#361" id="361">361</a>
<a href="#362" id="362">362</a>
<a href="#363" id="363">363</a>
<a href="#364" id="364">364</a>
<a href="#365" id="365">365</a>
<a href="#366" id="366">366</a>
<a href="#367" id="367">367</a>
<a href="#368" id="368">368</a>
<a href="#369" id="369">369</a>
<a href="#370" id="370">370</a>
<a href="#371" id="371">371</a>
<a href="#372" id="372">372</a>
<a href="#373" id="373">373</a>
<a href="#374" id="374">374</a>
<a href="#375" id="375">375</a>
<a href="#376" id="376">376</a>
<a href="#377" id="377">377</a>
<a href="#378" id="378">378</a>
<a href="#379" id="379">379</a>
<a href="#380" id="380">380</a>
<a href="#381" id="381">381</a>
<a href="#382" id="382">382</a>
<a href="#383" id="383">383</a>
<a href="#384" id="384">384</a>
<a href="#385" id="385">385</a>
<a href="#386" id="386">386</a>
<a href="#387" id="387">387</a>
<a href="#388" id="388">388</a>
<a href="#389" id="389">389</a>
<a href="#390" id="390">390</a>
<a href="#391" id="391">391</a>
<a href="#392" id="392">392</a>
<a href="#393" id="393">393</a>
<a href="#394" id="394">394</a>
<a href="#395" id="395">395</a>
<a href="#396" id="396">396</a>
<a href="#397" id="397">397</a>
<a href="#398" id="398">398</a>
<a href="#399" id="399">399</a>
<a href="#400" id="400">400</a>
<a href="#401" id="401">401</a>
<a href="#402" id="402">402</a>
<a href="#403" id="403">403</a>
<a href="#404" id="404">404</a>
<a href="#405" id="405">405</a>
<a href="#406" id="406">406</a>
<a href="#407" id="407">407</a>
<a href="#408" id="408">408</a>
<a href="#409" id="409">409</a>
<a href="#410" id="410">410</a>
<a href="#411" id="411">411</a>
<a href="#412" id="412">412</a>
<a href="#413" id="413">413</a>
<a href="#414" id="414">414</a>
<a href="#415" id="415">415</a>
<a href="#416" id="416">416</a>
<a href="#417" id="417">417</a>
</pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2022 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
// SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
//
// SPDX-License-Identifier: AGPL-3.0-or-later
</span><span class="attr">#![warn(missing_docs)]
</span><span class="doccomment">//! # `mCaptcha` database operations
//!
//! Traits and datastructures used in mCaptcha to interact with database.
//!
//! To use an unsupported database with mCaptcha, traits present within this crate should be
//! implemented.
//!
//!
//! ## Organisation
//!
//! Database functionality is divided across various modules:
//!
//! - [errors](crate::auth): error data structures used in this crate
//! - [ops](crate::ops): meta operations like connection pool creation, migrations and getting
//! connection from pool
</span><span class="kw">use </span>serde::{Deserialize, Serialize};
<span class="kw">pub use </span>libmcaptcha::defense::Level;
<span class="kw">pub mod </span>errors;
<span class="kw">pub mod </span>ops;
<span class="attr">#[cfg(feature = <span class="string">&quot;test&quot;</span>)]
</span><span class="kw">pub mod </span>tests;
<span class="kw">use </span>dev::<span class="kw-2">*</span>;
<span class="kw">pub use </span>ops::GetConnection;
<span class="kw">pub mod </span>prelude {
<span class="doccomment">//! useful imports for users working with a supported database
</span><span class="kw">pub use </span><span class="kw">super</span>::errors::<span class="kw-2">*</span>;
<span class="kw">pub use </span><span class="kw">super</span>::ops::<span class="kw-2">*</span>;
<span class="kw">pub use super</span>::<span class="kw-2">*</span>;
}
<span class="kw">pub mod </span>dev {
<span class="doccomment">//! useful imports for supporting a new database
</span><span class="kw">pub use </span><span class="kw">super</span>::prelude::<span class="kw-2">*</span>;
<span class="kw">pub use </span>async_trait::async_trait;
}
<span class="attr">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// Data required to register a new user
</span><span class="kw">pub struct </span>Register&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// username of new user
</span><span class="kw">pub </span>username: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// secret of new user
</span><span class="kw">pub </span>secret: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// hashed password of new use
</span><span class="kw">pub </span>hash: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// Optionally, email of new use
</span><span class="kw">pub </span>email: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt;,
}
<span class="attr">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// data required to update them email of a user
</span><span class="kw">pub struct </span>UpdateEmail&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// username of the user
</span><span class="kw">pub </span>username: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// new email address of the user
</span><span class="kw">pub </span>new_email: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="attr">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// types of credentials used as identifiers during login
</span><span class="kw">pub enum </span>Login&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// username as login
</span>Username(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str),
<span class="doccomment">/// email as login
</span>Email(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str),
}
<span class="attr">#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// type encapsulating username and hashed password of a user
</span><span class="kw">pub struct </span>NameHash {
<span class="doccomment">/// username
</span><span class="kw">pub </span>username: String,
<span class="doccomment">/// hashed password
</span><span class="kw">pub </span>hash: String,
}
<span class="attr">#[async_trait]
</span><span class="doccomment">/// mCaptcha&#39;s database requirements. To implement support for $Database, kindly implement this
/// trait.
</span><span class="kw">pub trait </span>MCDatabase: std::marker::Send + std::marker::Sync + CloneSPDatabase {
<span class="doccomment">/// ping DB
</span><span class="kw">async fn </span>ping(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool;
<span class="doccomment">/// register a new user
</span><span class="kw">async fn </span>register(<span class="kw-2">&amp;</span><span class="self">self</span>, p: <span class="kw-2">&amp;</span>Register) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// delete a user
</span><span class="kw">async fn </span>delete_user(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// check if username exists
</span><span class="kw">async fn </span>username_exists(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;bool&gt;;
<span class="doccomment">/// get user email
</span><span class="kw">async fn </span>get_email(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;<span class="prelude-ty">Option</span>&lt;String&gt;&gt;;
<span class="doccomment">/// check if email exists
</span><span class="kw">async fn </span>email_exists(<span class="kw-2">&amp;</span><span class="self">self</span>, email: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;bool&gt;;
<span class="doccomment">/// update a user&#39;s email
</span><span class="kw">async fn </span>update_email(<span class="kw-2">&amp;</span><span class="self">self</span>, p: <span class="kw-2">&amp;</span>UpdateEmail) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// get a user&#39;s password
</span><span class="kw">async fn </span>get_password(<span class="kw-2">&amp;</span><span class="self">self</span>, l: <span class="kw-2">&amp;</span>Login) -&gt; DBResult&lt;NameHash&gt;;
<span class="doccomment">/// update user&#39;s password
</span><span class="kw">async fn </span>update_password(<span class="kw-2">&amp;</span><span class="self">self</span>, p: <span class="kw-2">&amp;</span>NameHash) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// update username
</span><span class="kw">async fn </span>update_username(<span class="kw-2">&amp;</span><span class="self">self</span>, current: <span class="kw-2">&amp;</span>str, new: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// get a user&#39;s secret
</span><span class="kw">async fn </span>get_secret(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Secret&gt;;
<span class="doccomment">/// get a user&#39;s secret from a captcha key
</span><span class="kw">async fn </span>get_secret_from_captcha(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Secret&gt;;
<span class="doccomment">/// update a user&#39;s secret
</span><span class="kw">async fn </span>update_secret(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, secret: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// create new captcha
</span><span class="kw">async fn </span>create_captcha(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, p: <span class="kw-2">&amp;</span>CreateCaptcha) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Get captcha config
</span><span class="kw">async fn </span>get_captcha_config(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Captcha&gt;;
<span class="doccomment">/// Get all captchas belonging to user
</span><span class="kw">async fn </span>get_all_user_captchas(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Vec&lt;Captcha&gt;&gt;;
<span class="doccomment">/// update captcha metadata; doesn&#39;t change captcha key
</span><span class="kw">async fn </span>update_captcha_metadata(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
p: <span class="kw-2">&amp;</span>CreateCaptcha,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// update captcha key; doesn&#39;t change metadata
</span><span class="kw">async fn </span>update_captcha_key(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
old_key: <span class="kw-2">&amp;</span>str,
new_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Add levels to captcha
</span><span class="kw">async fn </span>add_captcha_levels(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
captcha_key: <span class="kw-2">&amp;</span>str,
levels: <span class="kw-2">&amp;</span>[Level],
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// check if captcha exists
</span><span class="kw">async fn </span>captcha_exists(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
captcha_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;bool&gt;;
<span class="doccomment">/// Delete all levels of a captcha
</span><span class="kw">async fn </span>delete_captcha_levels(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
captcha_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Delete captcha
</span><span class="kw">async fn </span>delete_captcha(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, captcha_key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Get captcha levels
</span><span class="kw">async fn </span>get_captcha_levels(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
captcha_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;Vec&lt;Level&gt;&gt;;
<span class="doccomment">/// Get captcha&#39;s cooldown period
</span><span class="kw">async fn </span>get_captcha_cooldown(<span class="kw-2">&amp;</span><span class="self">self</span>, captcha_key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;i32&gt;;
<span class="doccomment">/// Add traffic configuration
</span><span class="kw">async fn </span>add_traffic_pattern(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
captcha_key: <span class="kw-2">&amp;</span>str,
pattern: <span class="kw-2">&amp;</span>TrafficPattern,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Get traffic configuration
</span><span class="kw">async fn </span>get_traffic_pattern(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
captcha_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;TrafficPattern&gt;;
<span class="doccomment">/// Delete traffic configuration
</span><span class="kw">async fn </span>delete_traffic_pattern(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
captcha_key: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// create new notification
</span><span class="kw">async fn </span>create_notification(<span class="kw-2">&amp;</span><span class="self">self</span>, p: <span class="kw-2">&amp;</span>AddNotification) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// get all unread notifications
</span><span class="kw">async fn </span>get_all_unread_notifications(
<span class="kw-2">&amp;</span><span class="self">self</span>,
username: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;Vec&lt;Notification&gt;&gt;;
<span class="doccomment">/// mark a notification read
</span><span class="kw">async fn </span>mark_notification_read(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, id: i32) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// record PoWConfig fetches
</span><span class="kw">async fn </span>record_fetch(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// record PoWConfig solves
</span><span class="kw">async fn </span>record_solve(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// record PoWConfig confirms
</span><span class="kw">async fn </span>record_confirm(<span class="kw-2">&amp;</span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// fetch PoWConfig fetches
</span><span class="kw">async fn </span>fetch_config_fetched(<span class="kw-2">&amp;</span><span class="self">self</span>, user: <span class="kw-2">&amp;</span>str, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Vec&lt;i64&gt;&gt;;
<span class="doccomment">/// fetch PoWConfig solves
</span><span class="kw">async fn </span>fetch_solve(<span class="kw-2">&amp;</span><span class="self">self</span>, user: <span class="kw-2">&amp;</span>str, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Vec&lt;i64&gt;&gt;;
<span class="doccomment">/// fetch PoWConfig confirms
</span><span class="kw">async fn </span>fetch_confirm(<span class="kw-2">&amp;</span><span class="self">self</span>, user: <span class="kw-2">&amp;</span>str, key: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;Vec&lt;i64&gt;&gt;;
<span class="doccomment">/// record PoW timing
</span><span class="kw">async fn </span>analysis_save(
<span class="kw-2">&amp;</span><span class="self">self</span>,
captcha_id: <span class="kw-2">&amp;</span>str,
d: <span class="kw-2">&amp;</span>CreatePerformanceAnalytics,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// fetch PoW analytics
</span><span class="kw">async fn </span>analytics_fetch(
<span class="kw-2">&amp;</span><span class="self">self</span>,
captcha_id: <span class="kw-2">&amp;</span>str,
limit: usize,
offset: usize,
) -&gt; DBResult&lt;Vec&lt;PerformanceAnalytics&gt;&gt;;
<span class="doccomment">/// Create psuedo ID against campaign ID to publish analytics
</span><span class="kw">async fn </span>analytics_create_psuedo_id_if_not_exists(
<span class="kw-2">&amp;</span><span class="self">self</span>,
captcha_id: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Get psuedo ID from campaign ID
</span><span class="kw">async fn </span>analytics_get_psuedo_id_from_capmaign_id(
<span class="kw-2">&amp;</span><span class="self">self</span>,
captcha_id: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;String&gt;;
<span class="doccomment">/// Get campaign ID from psuedo ID
</span><span class="kw">async fn </span>analytics_get_capmaign_id_from_psuedo_id(
<span class="kw-2">&amp;</span><span class="self">self</span>,
psuedo_id: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;String&gt;;
<span class="doccomment">/// Delete all records for campaign
</span><span class="kw">async fn </span>analytics_delete_all_records_for_campaign(
<span class="kw-2">&amp;</span><span class="self">self</span>,
campaign_id: <span class="kw-2">&amp;</span>str,
) -&gt; DBResult&lt;()&gt;;
<span class="doccomment">/// Get publishing status of pow analytics for captcha ID/ campaign ID
</span><span class="kw">async fn </span>analytics_captcha_is_published(<span class="kw-2">&amp;</span><span class="self">self</span>, campaign_id: <span class="kw-2">&amp;</span>str) -&gt; DBResult&lt;bool&gt; {
<span class="kw">match </span><span class="self">self
</span>.analytics_get_psuedo_id_from_capmaign_id(campaign_id)
.<span class="kw">await
</span>{
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<span class="prelude-val">Err</span>(errors::DBError::CaptchaNotFound) =&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(e),
}
}
}
<span class="attr">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// Log Proof-of-Work CAPTCHA performance analytics
</span><span class="kw">pub struct </span>CreatePerformanceAnalytics {
<span class="doccomment">/// time taken to generate proof
</span><span class="kw">pub </span>time: u32,
<span class="doccomment">/// difficulty factor for which the proof was generated
</span><span class="kw">pub </span>difficulty_factor: u32,
<span class="doccomment">/// worker/client type: wasm, javascript, python, etc.
</span><span class="kw">pub </span>worker_type: String,
}
<span class="attr">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// Proof-of-Work CAPTCHA performance analytics
</span><span class="kw">pub struct </span>PerformanceAnalytics {
<span class="doccomment">/// log ID
</span><span class="kw">pub </span>id: usize,
<span class="doccomment">/// time taken to generate proof
</span><span class="kw">pub </span>time: u32,
<span class="doccomment">/// difficulty factor for which the proof was generated
</span><span class="kw">pub </span>difficulty_factor: u32,
<span class="doccomment">/// worker/client type: wasm, javascript, python, etc.
</span><span class="kw">pub </span>worker_type: String,
}
<span class="attr">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// Captcha statistics with time recorded in UNIX epoch formats
</span><span class="kw">pub struct </span>StatsUnixTimestamp {
<span class="doccomment">/// times at which the configuration were fetched
</span><span class="kw">pub </span>config_fetches: Vec&lt;i64&gt;,
<span class="doccomment">/// times at which the PoW was solved
</span><span class="kw">pub </span>solves: Vec&lt;i64&gt;,
<span class="doccomment">/// times at which the PoW token was verified
</span><span class="kw">pub </span>confirms: Vec&lt;i64&gt;,
}
<span class="attr">#[derive(Debug, Clone, Default, Deserialize, Serialize, PartialEq)]
</span><span class="doccomment">/// Represents notification
</span><span class="kw">pub struct </span>Notification {
<span class="doccomment">/// receiver name of the notification
</span><span class="kw">pub </span>name: <span class="prelude-ty">Option</span>&lt;String&gt;,
<span class="doccomment">/// heading of the notification
</span><span class="kw">pub </span>heading: <span class="prelude-ty">Option</span>&lt;String&gt;,
<span class="doccomment">/// message of the notification
</span><span class="kw">pub </span>message: <span class="prelude-ty">Option</span>&lt;String&gt;,
<span class="doccomment">/// when notification was received
</span><span class="kw">pub </span>received: <span class="prelude-ty">Option</span>&lt;i64&gt;,
<span class="doccomment">/// db assigned ID of the notification
</span><span class="kw">pub </span>id: <span class="prelude-ty">Option</span>&lt;i32&gt;,
}
<span class="attr">#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
</span><span class="doccomment">/// Data required to add notification
</span><span class="kw">pub struct </span>AddNotification&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// who is the notification addressed to?
</span><span class="kw">pub </span>to: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// notification sender
</span><span class="kw">pub </span>from: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// heading of the notification
</span><span class="kw">pub </span>heading: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// message of the notification
</span><span class="kw">pub </span>message: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="attr">#[derive(Default, PartialEq, Serialize, Deserialize, Clone, Debug)]
</span><span class="doccomment">/// User&#39;s traffic pattern; used in generating a captcha configuration
</span><span class="kw">pub struct </span>TrafficPattern {
<span class="doccomment">/// average traffic of user&#39;s website
</span><span class="kw">pub </span>avg_traffic: u32,
<span class="doccomment">/// the peak traffic that the user&#39;s website can handle
</span><span class="kw">pub </span>peak_sustainable_traffic: u32,
<span class="doccomment">/// traffic that bought the user&#39;s website down; optional
</span><span class="kw">pub </span>broke_my_site_traffic: <span class="prelude-ty">Option</span>&lt;u32&gt;,
}
<span class="attr">#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
</span><span class="doccomment">/// data required to create new captcha
</span><span class="kw">pub struct </span>CreateCaptcha&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// cool down duration
</span><span class="kw">pub </span>duration: i32,
<span class="doccomment">/// description of the captcha
</span><span class="kw">pub </span>description: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// secret key of the captcha
</span><span class="kw">pub </span>key: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="attr">#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
</span><span class="doccomment">/// Data representing a captcha
</span><span class="kw">pub struct </span>Captcha {
<span class="doccomment">/// Database assigned ID
</span><span class="kw">pub </span>config_id: i32,
<span class="doccomment">/// cool down duration
</span><span class="kw">pub </span>duration: i32,
<span class="doccomment">/// description of the captcha
</span><span class="kw">pub </span>description: String,
<span class="doccomment">/// secret key of the captcha
</span><span class="kw">pub </span>key: String,
}
<span class="attr">#[derive(Clone, Debug, Deserialize, PartialEq, Default, Serialize)]
</span><span class="doccomment">/// datastructure representing a user&#39;s secret
</span><span class="kw">pub struct </span>Secret {
<span class="doccomment">/// user&#39;s secret
</span><span class="kw">pub </span>secret: String,
}
<span class="doccomment">/// Trait to clone MCDatabase
</span><span class="kw">pub trait </span>CloneSPDatabase {
<span class="doccomment">/// clone DB
</span><span class="kw">fn </span>clone_db(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Box&lt;<span class="kw">dyn </span>MCDatabase&gt;;
}
<span class="kw">impl</span>&lt;T&gt; CloneSPDatabase <span class="kw">for </span>T
<span class="kw">where
</span>T: MCDatabase + Clone + <span class="lifetime">&#39;static</span>,
{
<span class="kw">fn </span>clone_db(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Box&lt;<span class="kw">dyn </span>MCDatabase&gt; {
Box::new(<span class="self">self</span>.clone())
}
}
<span class="kw">impl </span>Clone <span class="kw">for </span>Box&lt;<span class="kw">dyn </span>MCDatabase&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
(<span class="kw-2">**</span><span class="self">self</span>).clone_db()
}
}
</code></pre></div></section></main></body></html>