Mirroristas/mCaptcha
2
0
Fork 0
mirror of https://github.com/mCaptcha/mCaptcha.git synced 2025-06-24 23:22:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
mCaptcha/db_core/index.html

45 lines
11 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="`mCaptcha` database operations"><meta name="keywords" content="rust, rustlang, rust-lang, db_core"><title>db_core - Rust</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="../crates.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 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">&#9776;</button><a class="sidebar-logo" href="../db_core/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="../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate db_core</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><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></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../db_core/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"><button type="button" id="help-button" title="help">?</button><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="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">db_core</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/db_core/lib.rs.html#18-355">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-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">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>
<div class="item-table"><div class="item-row"><div class="item-left import-item" 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><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="dev/index.html" title="db_core::dev mod">dev</a></div><div class="item-right docblock-short"><p>useful imports for supporting a new database</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="errors/index.html" title="db_core::errors mod">errors</a></div><div class="item-right docblock-short"><p>represents all the ways a trait can fail using this crate</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ops/index.html" title="db_core::ops mod">ops</a></div><div class="item-right docblock-short"><p>meta operations like migration and connecting to a database</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="prelude/index.html" title="db_core::prelude mod">prelude</a></div><div class="item-right docblock-short"><p>useful imports for users working with a supported database</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tests/index.html" title="db_core::tests mod">tests</a></div><div class="item-right docblock-short"><p>Test utilities</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AddNotification.html" title="db_core::AddNotification struct">AddNotification</a></div><div class="item-right docblock-short"><p>Data required to add notification</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Captcha.html" title="db_core::Captcha struct">Captcha</a></div><div class="item-right docblock-short"><p>Data representing a captcha</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CreateCaptcha.html" title="db_core::CreateCaptcha struct">CreateCaptcha</a></div><div class="item-right docblock-short"><p>data required to create new captcha</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Level.html" title="db_core::Level struct">Level</a></div><div class="item-right docblock-short"><p>Level struct that describes threshold-difficulty factor mapping</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NameHash.html" title="db_core::NameHash struct">NameHash</a></div><div class="item-right docblock-short"><p>type encapsulating username and hashed password of a user</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Notification.html" title="db_core::Notification struct">Notification</a></div><div class="item-right docblock-short"><p>Represents notification</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Register.html" title="db_core::Register struct">Register</a></div><div class="item-right docblock-short"><p>Data required to register a new user</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Secret.html" title="db_core::Secret struct">Secret</a></div><div class="item-right docblock-short"><p>datastructure representing a user’s secret</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StatsUnixTimestamp.html" title="db_core::StatsUnixTimestamp struct">StatsUnixTimestamp</a></div><div class="item-right docblock-short"><p>Captcha statistics with time recorded in UNIX epoch formats</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrafficPattern.html" title="db_core::TrafficPattern struct">TrafficPattern</a></div><div class="item-right docblock-short"><p>User’s traffic pattern; used in generating a captcha configuration</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UpdateEmail.html" title="db_core::UpdateEmail struct">UpdateEmail</a></div><div class="item-right docblock-short"><p>data required to update them email of a user</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Login.html" title="db_core::Login enum">Login</a></div><div class="item-right docblock-short"><p>types of credentials used as identifiers during login</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CloneSPDatabase.html" title="db_core::CloneSPDatabase trait">CloneSPDatabase</a></div><div class="item-right docblock-short"><p>Trait to clone MCDatabase</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.MCDatabase.html" title="db_core::MCDatabase trait">MCDatabase</a></div><div class="item-right docblock-short"><p>mCaptcha’s database requirements. To implement support for $Database, kindly implement this
trait.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0 (4b91a6ea7 2022-08-08)" ></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink