13 lines
No EOL
11 KiB
HTML
13 lines
No EOL
11 KiB
HTML
<!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="`mCaptcha` database operations"><title>db_core - Rust</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-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="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.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../static.files/noscript-cffde32267a19fd6.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 mod crate"><!--[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">☰</button><a class="logo-container" href="../db_core/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../db_core/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate db_core</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><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="main-heading"><h1>Crate <a class="mod" href="#">db_core</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/db_core/lib.rs.html#6-446">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="mcaptcha-database-operations"><a href="#mcaptcha-database-operations"><code>mCaptcha</code> database operations</a></h2>
|
||
<p>Traits and datastructures used in mCaptcha to interact with database.</p>
|
||
<p>To use an unsupported database with mCaptcha, traits present within this crate should be
|
||
implemented.</p>
|
||
<h3 id="organisation"><a href="#organisation">Organisation</a></h3>
|
||
<p>Database functionality is divided across various modules:</p>
|
||
<ul>
|
||
<li><a href="crate::auth">errors</a>: error data structures used in this crate</li>
|
||
<li><a href="ops/index.html" title="mod db_core::ops">ops</a>: meta operations like connection pool creation, migrations and getting
|
||
connection from pool</li>
|
||
</ul>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.GetConnection"><code>pub use ops::<a class="trait" href="ops/trait.GetConnection.html" title="trait db_core::ops::GetConnection">GetConnection</a>;</code></div></li></ul><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="dev/index.html" title="mod db_core::dev">dev</a></div><div class="desc docblock-short">useful imports for supporting a new database</div></li><li><div class="item-name"><a class="mod" href="errors/index.html" title="mod db_core::errors">errors</a></div><div class="desc docblock-short">represents all the ways a trait can fail using this crate</div></li><li><div class="item-name"><a class="mod" href="ops/index.html" title="mod db_core::ops">ops</a></div><div class="desc docblock-short">meta operations like migration and connecting to a database</div></li><li><div class="item-name"><a class="mod" href="prelude/index.html" title="mod db_core::prelude">prelude</a></div><div class="desc docblock-short">useful imports for users working with a supported database</div></li><li><div class="item-name"><a class="mod" href="tests/index.html" title="mod db_core::tests">tests</a></div><div class="desc docblock-short">Test utilities</div></li></ul><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddNotification.html" title="struct db_core::AddNotification">AddNotification</a></div><div class="desc docblock-short">Data required to add notification</div></li><li><div class="item-name"><a class="struct" href="struct.Captcha.html" title="struct db_core::Captcha">Captcha</a></div><div class="desc docblock-short">Data representing a captcha</div></li><li><div class="item-name"><a class="struct" href="struct.CreateCaptcha.html" title="struct db_core::CreateCaptcha">CreateCaptcha</a></div><div class="desc docblock-short">data required to create new captcha</div></li><li><div class="item-name"><a class="struct" href="struct.CreatePerformanceAnalytics.html" title="struct db_core::CreatePerformanceAnalytics">CreatePerformanceAnalytics</a></div><div class="desc docblock-short">Log Proof-of-Work CAPTCHA performance analytics</div></li><li><div class="item-name"><a class="struct" href="struct.Level.html" title="struct db_core::Level">Level</a></div><div class="desc docblock-short">Level struct that describes threshold-difficulty factor mapping</div></li><li><div class="item-name"><a class="struct" href="struct.NameHash.html" title="struct db_core::NameHash">NameHash</a></div><div class="desc docblock-short">type encapsulating username and hashed password of a user</div></li><li><div class="item-name"><a class="struct" href="struct.Notification.html" title="struct db_core::Notification">Notification</a></div><div class="desc docblock-short">Represents notification</div></li><li><div class="item-name"><a class="struct" href="struct.PerformanceAnalytics.html" title="struct db_core::PerformanceAnalytics">PerformanceAnalytics</a></div><div class="desc docblock-short">Proof-of-Work CAPTCHA performance analytics</div></li><li><div class="item-name"><a class="struct" href="struct.Register.html" title="struct db_core::Register">Register</a></div><div class="desc docblock-short">Data required to register a new user</div></li><li><div class="item-name"><a class="struct" href="struct.Secret.html" title="struct db_core::Secret">Secret</a></div><div class="desc docblock-short">datastructure representing a user’s secret</div></li><li><div class="item-name"><a class="struct" href="struct.StatsUnixTimestamp.html" title="struct db_core::StatsUnixTimestamp">StatsUnixTimestamp</a></div><div class="desc docblock-short">Captcha statistics with time recorded in UNIX epoch formats</div></li><li><div class="item-name"><a class="struct" href="struct.TrafficPattern.html" title="struct db_core::TrafficPattern">TrafficPattern</a></div><div class="desc docblock-short">User’s traffic pattern; used in generating a captcha configuration</div></li><li><div class="item-name"><a class="struct" href="struct.UpdateEmail.html" title="struct db_core::UpdateEmail">UpdateEmail</a></div><div class="desc docblock-short">data required to update them email of a user</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Login.html" title="enum db_core::Login">Login</a></div><div class="desc docblock-short">types of credentials used as identifiers during login</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.CloneSPDatabase.html" title="trait db_core::CloneSPDatabase">CloneSPDatabase</a></div><div class="desc docblock-short">Trait to clone MCDatabase</div></li><li><div class="item-name"><a class="trait" href="trait.MCDatabase.html" title="trait db_core::MCDatabase">MCDatabase</a></div><div class="desc docblock-short">mCaptcha’s database requirements. To implement support for $Database, kindly implement this
|
||
trait.</div></li></ul></section></div></main></body></html> |