Deploying to gh-pages from @ ac502b7c08 🚀

This commit is contained in:
realaravinth
2022-11-04 10:05:00 +00:00
parent 49538a56a4
commit 55a5f29113
941 changed files with 22322 additions and 30474 deletions

View File

@@ -1,4 +1,4 @@
<!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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" type="text/css" href="../../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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">&#9776;</button><a class="sidebar-logo" href="../../../../../mcaptcha/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="../../../../../mcaptcha/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="../../../../../mcaptcha/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>
<!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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">&#9776;</button><a class="sidebar-logo" href="../../../../../mcaptcha/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="../../../../../mcaptcha/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="../../../../../mcaptcha/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>
@@ -109,86 +109,86 @@
*
* 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">actix_web::web</span>;
</span><span class="kw">use </span>actix_web::web;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">get_config</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">verify_pow</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">verify_token</span>;
<span class="kw">pub mod </span>get_config;
<span class="kw">pub mod </span>verify_pow;
<span class="kw">pub mod </span>verify_token;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">super</span>::mcaptcha::get::I32Levels</span>;
<span class="kw">pub use </span><span class="kw">super</span>::mcaptcha::get::I32Levels;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">services</span>(<span class="ident">cfg</span>: <span class="kw-2">&amp;mut</span> <span class="ident">web::ServiceConfig</span>) {
<span class="kw">let</span> <span class="ident">cors</span> <span class="op">=</span> <span class="ident">actix_cors::Cors::default</span>()
.<span class="ident">allow_any_origin</span>()
.<span class="ident">allowed_methods</span>(<span class="macro">vec!</span>[<span class="string">&quot;POST&quot;</span>, <span class="string">&quot;GET&quot;</span>])
.<span class="ident">allow_any_header</span>()
.<span class="ident">max_age</span>(<span class="number">3600</span>)
.<span class="ident">send_wildcard</span>();
<span class="kw">pub fn </span>services(cfg: <span class="kw-2">&amp;mut </span>web::ServiceConfig) {
<span class="kw">let </span>cors = actix_cors::Cors::default()
.allow_any_origin()
.allowed_methods(<span class="macro">vec!</span>[<span class="string">&quot;POST&quot;</span>, <span class="string">&quot;GET&quot;</span>])
.allow_any_header()
.max_age(<span class="number">3600</span>)
.send_wildcard();
<span class="kw">let</span> <span class="ident">routes</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::V1_API_ROUTES</span>.<span class="ident">pow</span>;
<span class="ident">cfg</span>.<span class="ident">service</span>(
<span class="ident">web::scope</span>(<span class="ident">routes</span>.<span class="ident">scope</span>)
.<span class="ident">wrap</span>(<span class="ident">cors</span>)
.<span class="ident">service</span>(<span class="ident">verify_pow::verify_pow</span>)
.<span class="ident">service</span>(<span class="ident">get_config::get_config</span>)
.<span class="ident">service</span>(<span class="ident">verify_token::validate_captcha_token</span>),
<span class="kw">let </span>routes = <span class="kw">crate</span>::V1_API_ROUTES.pow;
cfg.service(
web::scope(routes.scope)
.wrap(cors)
.service(verify_pow::verify_pow)
.service(get_config::get_config)
.service(verify_token::validate_captcha_token),
);
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">routes</span> {
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PoW</span> {
<span class="kw">pub</span> <span class="ident">get_config</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span>,
<span class="kw">pub</span> <span class="ident">verify_pow</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span>,
<span class="kw">pub</span> <span class="ident">validate_captcha_token</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span>,
<span class="kw">pub</span> <span class="ident">scope</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span>,
<span class="kw">pub mod </span>routes {
<span class="kw">pub struct </span>PoW {
<span class="kw">pub </span>get_config: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
<span class="kw">pub </span>verify_pow: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
<span class="kw">pub </span>validate_captcha_token: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
<span class="kw">pub </span>scope: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
}
<span class="macro">macro_rules!</span> <span class="ident">rm_scope</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>) =&gt; {
<span class="doccomment">/// remove scope for $name route</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="ident">str</span> {
<span class="self">self</span>.<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>
<span class="comment">//.strip_prefix(&amp;self.scope[..self.scope.len() - 1])</span>
.<span class="ident">strip_prefix</span>(<span class="self">self</span>.<span class="ident">scope</span>)
.<span class="ident">unwrap</span>()
<span class="macro">macro_rules! </span>rm_scope {
(<span class="macro-nonterminal">$name</span>:ident) =&gt; {
<span class="doccomment">/// remove scope for $name route
</span><span class="kw">pub fn </span><span class="macro-nonterminal">$name</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<span class="self">self</span>.<span class="macro-nonterminal">$name
</span><span class="comment">//.strip_prefix(&amp;self.scope[..self.scope.len() - 1])
</span>.strip_prefix(<span class="self">self</span>.scope)
.unwrap()
}
};
}
<span class="kw">impl</span> <span class="ident">PoW</span> {
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -&gt; <span class="self">Self</span> {
<span class="comment">// date: 2021-11-29 16:31</span>
<span class="comment">// commit: 6eb75d7</span>
<span class="comment">// route 404s when scope contained trailing slash</span>
<span class="comment">//let scope = &quot;/api/v1/pow/&quot;;</span>
<span class="kw">let</span> <span class="ident">scope</span> <span class="op">=</span> <span class="string">&quot;/api/v1/pow&quot;</span>;
<span class="ident">PoW</span> {
<span class="ident">get_config</span>: <span class="string">&quot;/api/v1/pow/config&quot;</span>,
<span class="ident">verify_pow</span>: <span class="string">&quot;/api/v1/pow/verify&quot;</span>,
<span class="ident">validate_captcha_token</span>: <span class="string">&quot;/api/v1/pow/siteverify&quot;</span>,
<span class="ident">scope</span>,
<span class="kw">impl </span>PoW {
<span class="kw">pub const fn </span>new() -&gt; <span class="self">Self </span>{
<span class="comment">// date: 2021-11-29 16:31
// commit: 6eb75d7
// route 404s when scope contained trailing slash
//let scope = &quot;/api/v1/pow/&quot;;
</span><span class="kw">let </span>scope = <span class="string">&quot;/api/v1/pow&quot;</span>;
PoW {
get_config: <span class="string">&quot;/api/v1/pow/config&quot;</span>,
verify_pow: <span class="string">&quot;/api/v1/pow/verify&quot;</span>,
validate_captcha_token: <span class="string">&quot;/api/v1/pow/siteverify&quot;</span>,
scope,
}
}
<span class="macro">rm_scope!</span>(<span class="ident">get_config</span>);
<span class="macro">rm_scope!</span>(<span class="ident">verify_pow</span>);
<span class="macro">rm_scope!</span>(<span class="ident">validate_captcha_token</span>);
<span class="macro">rm_scope!</span>(get_config);
<span class="macro">rm_scope!</span>(verify_pow);
<span class="macro">rm_scope!</span>(validate_captcha_token);
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::routes::PoW</span>;
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::routes::PoW;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">scope_pow_works</span>() {
<span class="kw">let</span> <span class="ident">pow</span> <span class="op">=</span> <span class="ident">PoW::new</span>();
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">get_config</span>(), <span class="string">&quot;/config&quot;</span>);
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">verify_pow</span>(), <span class="string">&quot;/verify&quot;</span>);
<span class="macro">assert_eq!</span>(<span class="ident">pow</span>.<span class="ident">validate_captcha_token</span>(), <span class="string">&quot;/siteverify&quot;</span>);
<span class="attribute">#[test]
</span><span class="kw">fn </span>scope_pow_works() {
<span class="kw">let </span>pow = PoW::new();
<span class="macro">assert_eq!</span>(pow.get_config(), <span class="string">&quot;/config&quot;</span>);
<span class="macro">assert_eq!</span>(pow.verify_pow(), <span class="string">&quot;/verify&quot;</span>);
<span class="macro">assert_eq!</span>(pow.validate_captcha_token(), <span class="string">&quot;/siteverify&quot;</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mcaptcha" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="mcaptcha" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>