Deploying to gh-pages from @ 3cd38511fa 🚀

This commit is contained in:
realaravinth
2024-02-19 14:58:12 +00:00
parent 120b15c0c7
commit 500a7b89d5
757 changed files with 20470 additions and 19361 deletions

View File

@@ -1,4 +1,5 @@
<!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/api/v1/pow/get_config.rs`."><title>get_config.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mcaptcha" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-5d8b3c7633ad77ba.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><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>
<!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/api/v1/pow/get_config.rs`."><title>get_config.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mcaptcha" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../../../../../static.files/src-script-39ed315d46fb705f.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-feafe1bb7466e4bd.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><div class="sidebar-resizer"></div>
<main><nav class="sub"><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" tabindex="-1"><a href="../../../../../help.html" title="help">?</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>
@@ -312,7 +313,7 @@
}
<span class="doccomment">/// get PoW configuration for an mcaptcha key
</span><span class="attr">#[my_codegen::post(path = <span class="string">&quot;V1_API_ROUTES.pow.get_config()&quot;</span>)]
</span><span class="attr">#[my_codegen::post(path = <span class="string">"V1_API_ROUTES.pow.get_config()"</span>)]
</span><span class="kw">pub async fn </span>get_config(
payload: web::Json&lt;GetConfigPayload&gt;,
data: AppData,
@@ -332,7 +333,7 @@
.captcha
.get_pow(payload.key.clone())
.<span class="kw">await
</span>.expect(<span class="string">&quot;mcaptcha should be initialized and ready to go&quot;</span>);
</span>.expect(<span class="string">"mcaptcha should be initialized and ready to go"</span>);
<span class="prelude-val">Ok</span>(config.unwrap())
}
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(e.into()),
@@ -357,7 +358,7 @@
/// This fn gets mcaptcha config from database, builds [Defense][libmcaptcha::Defense],
/// creates [MCaptcha][libmcaptcha::MCaptcha] and adds it to [Master][libmcaptcha::Defense]
</span><span class="kw">pub async fn </span>init_mcaptcha(data: <span class="kw-2">&amp;</span>AppData, key: <span class="kw-2">&amp;</span>str) -&gt; ServiceResult&lt;()&gt; {
<span class="macro">println!</span>(<span class="string">&quot;Initializing captcha&quot;</span>);
<span class="macro">println!</span>(<span class="string">"Initializing captcha"</span>);
<span class="comment">// get levels
</span><span class="kw">let </span>levels = data.db.get_captcha_levels(<span class="prelude-val">None</span>, key).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>duration = data.db.get_captcha_cooldown(key).<span class="kw">await</span><span class="question-mark">?</span>;
@@ -376,12 +377,12 @@
}
<span class="kw">let </span>defense = defense.build()<span class="question-mark">?</span>;
<span class="macro">println!</span>(<span class="string">&quot;{:?}&quot;</span>, defense);
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, defense);
<span class="comment">// create captcha
</span><span class="kw">let </span>mcaptcha = MCaptchaBuilder::default()
.defense(defense)
<span class="comment">// leaky bucket algorithm&#39;s emission interval
<span class="comment">// leaky bucket algorithm's emission interval
</span>.duration(duration <span class="kw">as </span>u64)
<span class="comment">// .cache(cache)
</span>.build()
@@ -422,9 +423,9 @@
<span class="kw">use crate</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>actix_web::test;
<span class="kw">const </span>NAME: <span class="kw-2">&amp;</span>str = <span class="string">&quot;powusrworks&quot;</span>;
<span class="kw">const </span>PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">&quot;testingpas&quot;</span>;
<span class="kw">const </span>EMAIL: <span class="kw-2">&amp;</span>str = <span class="string">&quot;randomuser@a.com&quot;</span>;
<span class="kw">const </span>NAME: <span class="kw-2">&amp;</span>str = <span class="string">"powusrworks"</span>;
<span class="kw">const </span>PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">"testingpas"</span>;
<span class="kw">const </span>EMAIL: <span class="kw-2">&amp;</span>str = <span class="string">"randomuser@a.com"</span>;
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>data;
@@ -441,7 +442,7 @@
<span class="comment">// update and check changes
</span><span class="kw">let </span>url = V1_API_ROUTES.pow.get_config;
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, <span class="kw-2">&amp;</span>url);
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="kw-2">&amp;</span>url);
<span class="kw">let </span>get_config_resp = test::call_service(
<span class="kw-2">&amp;</span>app,
<span class="macro">post_request!</span>(<span class="kw-2">&amp;</span>get_config_payload, V1_API_ROUTES.pow.get_config)
@@ -478,9 +479,9 @@
<span class="kw">use </span><span class="kw">crate</span>::api::v1::mcaptcha::create::CreateCaptcha;
<span class="kw">use </span><span class="kw">crate</span>::api::v1::mcaptcha::create::MCaptchaDetails;
<span class="kw">const </span>NAME: <span class="kw-2">&amp;</span>str = <span class="string">&quot;powusrworks2&quot;</span>;
<span class="kw">const </span>PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">&quot;testingpas&quot;</span>;
<span class="kw">const </span>EMAIL: <span class="kw-2">&amp;</span>str = <span class="string">&quot;randomuser2@a.com&quot;</span>;
<span class="kw">const </span>NAME: <span class="kw-2">&amp;</span>str = <span class="string">"powusrworks2"</span>;
<span class="kw">const </span>PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">"testingpas"</span>;
<span class="kw">const </span>EMAIL: <span class="kw-2">&amp;</span>str = <span class="string">"randomuser2@a.com"</span>;
<span class="kw">pub const </span>L1: Level = Level {
difficulty_factor: <span class="number">10</span>,
visitor_threshold: <span class="number">10</span>,
@@ -507,7 +508,7 @@
<span class="kw">let </span>create_captcha = CreateCaptcha {
levels: levels.into(),
duration: <span class="number">30</span>,
description: <span class="string">&quot;dummy&quot;</span>.into(),
description: <span class="string">"dummy"</span>.into(),
publish_benchmarks: <span class="bool-val">true</span>,
};
@@ -547,7 +548,7 @@
<span class="kw">let </span>config: PoWConfig = test::read_body_json(get_config_resp).<span class="kw">await</span>;
<span class="macro">println!</span>(
<span class="string">&quot;[{count}] received difficulty_factor: {} prev difficulty_factor {}&quot;</span>,
<span class="string">"[{count}] received difficulty_factor: {} prev difficulty_factor {}"</span>,
config.difficulty_factor, prev
);
<span class="kw">if </span>count == levels.len() - <span class="number">1 </span>{