Deploying to gh-pages from @ 46098ec85b 🚀

This commit is contained in:
realaravinth
2021-06-30 17:21:19 +00:00
parent b2d92abb52
commit 919977397b
403 changed files with 14815 additions and 30731 deletions

View File

@@ -1,7 +1,7 @@
<!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/docs.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>docs.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">
<!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/docs.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>docs.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><script src="../../crates.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='../../mcaptcha/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>
<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 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../mcaptcha/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" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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" height="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>
@@ -151,16 +151,16 @@
* 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">borrow</span>::<span class="ident">Cow</span>;
<span class="kw">use</span> <span class="ident">std::borrow::Cow</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">body</span>::<span class="ident">Body</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>::<span class="ident">header</span>, <span class="ident">web</span>, <span class="ident">HttpResponse</span>, <span class="ident">Responder</span>};
<span class="kw">use</span> <span class="ident">mime_guess</span>::<span class="ident">from_path</span>;
<span class="kw">use</span> <span class="ident">rust_embed</span>::<span class="ident">RustEmbed</span>;
<span class="kw">use</span> <span class="ident">actix_web::body::Body</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http::header</span>, <span class="ident">web</span>, <span class="ident">HttpResponse</span>, <span class="ident">Responder</span>};
<span class="kw">use</span> <span class="ident">mime_guess::from_path</span>;
<span class="kw">use</span> <span class="ident">rust_embed::RustEmbed</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">CACHE_AGE</span>;
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::CACHE_AGE</span>;
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DOCS</span>: <span class="ident">routes</span>::<span class="ident">Docs</span> <span class="op">=</span> <span class="ident">routes</span>::<span class="ident">Docs</span>::<span class="ident">new</span>();
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DOCS</span>: <span class="ident">routes::Docs</span> <span class="op">=</span> <span class="ident">routes::Docs::new</span>();
<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">Docs</span> {
@@ -180,11 +180,11 @@
}
}
<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;</span><span class="kw-2">mut</span> <span class="ident">web</span>::<span class="ident">ServiceConfig</span>) {
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">define_resource</span>;
<span class="macro">define_resource</span><span class="macro">!</span>(<span class="ident">cfg</span>, <span class="kw-2">&amp;</span><span class="ident">DOCS</span>.<span class="ident">home</span>[<span class="number">0</span>..<span class="ident">DOCS</span>.<span class="ident">home</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="number">1</span>], <span class="ident">Methods</span>::<span class="ident">Get</span>, <span class="ident">index</span>);
<span class="macro">define_resource</span><span class="macro">!</span>(<span class="ident">cfg</span>, <span class="ident">DOCS</span>.<span class="ident">spec</span>, <span class="ident">Methods</span>::<span class="ident">Get</span>, <span class="ident">spec</span>);
<span class="macro">define_resource</span><span class="macro">!</span>(<span class="ident">cfg</span>, <span class="ident">DOCS</span>.<span class="ident">assets</span>, <span class="ident">Methods</span>::<span class="ident">Get</span>, <span class="ident">dist</span>);
<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;</span><span class="kw-2">mut</span> <span class="ident">web::ServiceConfig</span>) {
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::define_resource</span>;
<span class="macro">define_resource!</span>(<span class="ident">cfg</span>, <span class="kw-2">&amp;</span><span class="ident">DOCS</span>.<span class="ident">home</span>[<span class="number">0</span>..<span class="ident">DOCS</span>.<span class="ident">home</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="number">1</span>], <span class="ident">Methods::Get</span>, <span class="ident">index</span>);
<span class="macro">define_resource!</span>(<span class="ident">cfg</span>, <span class="ident">DOCS</span>.<span class="ident">spec</span>, <span class="ident">Methods::Get</span>, <span class="ident">spec</span>);
<span class="macro">define_resource!</span>(<span class="ident">cfg</span>, <span class="ident">DOCS</span>.<span class="ident">assets</span>, <span class="ident">Methods::Get</span>, <span class="ident">dist</span>);
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">RustEmbed</span>)]</span>
@@ -192,31 +192,31 @@
<span class="kw">struct</span> <span class="ident">Asset</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">handle_embedded_file</span>(<span class="ident">path</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">HttpResponse</span> {
<span class="kw">match</span> <span class="ident">Asset</span>::<span class="ident">get</span>(<span class="ident">path</span>) {
<span class="kw">match</span> <span class="ident">Asset::get</span>(<span class="ident">path</span>) {
<span class="prelude-val">Some</span>(<span class="ident">content</span>) <span class="op">=</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">body</span>: <span class="ident">Body</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">content</span> {
<span class="ident">Cow</span>::<span class="ident">Borrowed</span>(<span class="ident">bytes</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">bytes</span>.<span class="ident">into</span>(),
<span class="ident">Cow</span>::<span class="ident">Owned</span>(<span class="ident">bytes</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">bytes</span>.<span class="ident">into</span>(),
<span class="ident">Cow::Borrowed</span>(<span class="ident">bytes</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">bytes</span>.<span class="ident">into</span>(),
<span class="ident">Cow::Owned</span>(<span class="ident">bytes</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="ident">bytes</span>.<span class="ident">into</span>(),
};
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()
.<span class="ident">set</span>(<span class="ident">header</span>::<span class="ident">CacheControl</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">header</span>::<span class="ident">CacheDirective</span>::<span class="ident">MaxAge</span>(
<span class="ident">CACHE_AGE</span>,
)]))
<span class="ident">HttpResponse::Ok</span>()
.<span class="ident">insert_header</span>(<span class="ident">header::CacheControl</span>(<span class="macro">vec!</span>[
<span class="ident">header::CacheDirective::MaxAge</span>(<span class="ident">CACHE_AGE</span>),
]))
.<span class="ident">content_type</span>(<span class="ident">from_path</span>(<span class="ident">path</span>).<span class="ident">first_or_octet_stream</span>().<span class="ident">as_ref</span>())
.<span class="ident">body</span>(<span class="ident">body</span>)
}
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">&gt;</span> <span class="ident">HttpResponse</span>::<span class="ident">NotFound</span>().<span class="ident">body</span>(<span class="string">&quot;404 Not Found&quot;</span>),
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">&gt;</span> <span class="ident">HttpResponse::NotFound</span>().<span class="ident">body</span>(<span class="string">&quot;404 Not Found&quot;</span>),
}
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">dist</span>(<span class="ident">path</span>: <span class="ident">web</span>::<span class="ident">Path</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="ident">handle_embedded_file</span>(<span class="kw-2">&amp;</span><span class="ident">path</span>.<span class="number">0</span>)
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">dist</span>(<span class="ident">path</span>: <span class="ident">web::Path</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="ident">handle_embedded_file</span>(<span class="kw-2">&amp;</span><span class="ident">path</span>)
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">spec</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="ident">HttpResponse</span> {
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()
<span class="ident">HttpResponse::Ok</span>()
.<span class="ident">content_type</span>(<span class="string">&quot;appilcation/json&quot;</span>)
.<span class="ident">body</span>(<span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="kw">crate</span>::<span class="ident">OPEN_API_DOC</span>)
.<span class="ident">body</span>(<span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="kw">crate</span><span class="ident">::OPEN_API_DOC</span>)
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">index</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="ident">HttpResponse</span> {
@@ -225,49 +225,49 @@
<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">actix_web</span>::<span class="ident">http</span>::<span class="ident">StatusCode</span>;
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">test</span>;
<span class="kw">use</span> <span class="ident">actix_web::http::StatusCode</span>;
<span class="kw">use</span> <span class="ident">actix_web::test</span>;
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">actix_rt</span>::<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">actix_rt::test</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">docs_works</span>() {
<span class="kw">const</span> <span class="ident">FILE</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;favicon-32x32.png&quot;</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">init_service</span>(
<span class="ident">App</span>::<span class="ident">new</span>()
.<span class="ident">wrap</span>(<span class="ident">actix_middleware</span>::<span class="ident">NormalizePath</span>::<span class="ident">new</span>(
<span class="ident">actix_middleware</span>::<span class="ident">normalize</span>::<span class="ident">TrailingSlash</span>::<span class="ident">Trim</span>,
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">test::init_service</span>(
<span class="ident">App::new</span>()
.<span class="ident">wrap</span>(<span class="ident">actix_middleware::NormalizePath::new</span>(
<span class="ident">actix_middleware::TrailingSlash::Trim</span>,
))
.<span class="ident">configure</span>(<span class="ident">services</span>),
)
.<span class="kw">await</span>;
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">call_service</span>(
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test::call_service</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">app</span>,
<span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">get</span>().<span class="ident">uri</span>(<span class="ident">DOCS</span>.<span class="ident">home</span>).<span class="ident">to_request</span>(),
<span class="ident">test::TestRequest::get</span>().<span class="ident">uri</span>(<span class="ident">DOCS</span>.<span class="ident">home</span>).<span class="ident">to_request</span>(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
<span class="macro">assert_eq!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode::OK</span>);
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">call_service</span>(
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test::call_service</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">app</span>,
<span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">get</span>().<span class="ident">uri</span>(<span class="ident">DOCS</span>.<span class="ident">spec</span>).<span class="ident">to_request</span>(),
<span class="ident">test::TestRequest::get</span>().<span class="ident">uri</span>(<span class="ident">DOCS</span>.<span class="ident">spec</span>).<span class="ident">to_request</span>(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
<span class="macro">assert_eq!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode::OK</span>);
<span class="kw">let</span> <span class="ident">uri</span> <span class="op">=</span> <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}{}&quot;</span>, <span class="ident">DOCS</span>.<span class="ident">home</span>, <span class="ident">FILE</span>);
<span class="kw">let</span> <span class="ident">uri</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">&quot;{}{}&quot;</span>, <span class="ident">DOCS</span>.<span class="ident">home</span>, <span class="ident">FILE</span>);
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">call_service</span>(
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">test::call_service</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">app</span>,
<span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">get</span>().<span class="ident">uri</span>(<span class="kw-2">&amp;</span><span class="ident">uri</span>).<span class="ident">to_request</span>(),
<span class="ident">test::TestRequest::get</span>().<span class="ident">uri</span>(<span class="kw-2">&amp;</span><span class="ident">uri</span>).<span class="ident">to_request</span>(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
<span class="macro">assert_eq!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode::OK</span>);
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha"></div>
<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>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>