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

13 lines
8.8 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"><title>db_core - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-aa0817cf.css"><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.90.0 (1159e78c4 2025-09-14)" data-channel="1.90.0" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../static.files/storage-68b7e25d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../db_core/index.html">db_core</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#mcaptcha-database-operations" title="`mCaptcha` database operations"><code>mCaptcha</code> database operations</a><ul><li><a href="#organisation" title="Organisation">Organisation</a></li></ul></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>db_core</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/db_core/lib.rs.html#6-466">Source</a> </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 class="doc-anchor" href="#mcaptcha-database-operations">§</a><code>mCaptcha</code> database operations</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 class="doc-anchor" href="#organisation">§</a>Organisation</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="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.GetConnection"><code>pub use ops::<a class="trait" href="ops/trait.GetConnection.html" title="trait db_core::ops::GetConnection">GetConnection</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="dev/index.html" title="mod db_core::dev">dev</a></dt><dd>useful imports for supporting a new database</dd><dt><a class="mod" href="errors/index.html" title="mod db_core::errors">errors</a></dt><dd>represents all the ways a trait can fail using this crate</dd><dt><a class="mod" href="ops/index.html" title="mod db_core::ops">ops</a></dt><dd>meta operations like migration and connecting to a database</dd><dt><a class="mod" href="prelude/index.html" title="mod db_core::prelude">prelude</a></dt><dd>useful imports for users working with a supported database</dd><dt><a class="mod" href="tests/index.html" title="mod db_core::tests">tests</a></dt><dd>Test utilities</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AddNotification.html" title="struct db_core::AddNotification">AddNotification</a></dt><dd>Data required to add notification</dd><dt><a class="struct" href="struct.Captcha.html" title="struct db_core::Captcha">Captcha</a></dt><dd>Data representing a captcha</dd><dt><a class="struct" href="struct.CreateCaptcha.html" title="struct db_core::CreateCaptcha">Create<wbr>Captcha</a></dt><dd>data required to create new captcha</dd><dt><a class="struct" href="struct.CreatePerformanceAnalytics.html" title="struct db_core::CreatePerformanceAnalytics">Create<wbr>Performance<wbr>Analytics</a></dt><dd>Log Proof-of-Work CAPTCHA performance analytics</dd><dt><a class="struct" href="struct.EasyCaptcha.html" title="struct db_core::EasyCaptcha">Easy<wbr>Captcha</a></dt><dd>Represents Easy captcha configuration</dd><dt><a class="struct" href="struct.Level.html" title="struct db_core::Level">Level</a></dt><dd>Level struct that describes threshold-difficulty factor mapping</dd><dt><a class="struct" href="struct.NameHash.html" title="struct db_core::NameHash">Name<wbr>Hash</a></dt><dd>type encapsulating username and hashed password of a user</dd><dt><a class="struct" href="struct.Notification.html" title="struct db_core::Notification">Notification</a></dt><dd>Represents notification</dd><dt><a class="struct" href="struct.PerformanceAnalytics.html" title="struct db_core::PerformanceAnalytics">Performance<wbr>Analytics</a></dt><dd>Proof-of-Work CAPTCHA performance analytics</dd><dt><a class="struct" href="struct.Register.html" title="struct db_core::Register">Register</a></dt><dd>Data required to register a new user</dd><dt><a class="struct" href="struct.Secret.html" title="struct db_core::Secret">Secret</a></dt><dd>datastructure representing a user’s secret</dd><dt><a class="struct" href="struct.StatsUnixTimestamp.html" title="struct db_core::StatsUnixTimestamp">Stats<wbr>Unix<wbr>Timestamp</a></dt><dd>Captcha statistics with time recorded in UNIX epoch formats</dd><dt><a class="struct" href="struct.TrafficPattern.html" title="struct db_core::TrafficPattern">Traffic<wbr>Pattern</a></dt><dd>User’s traffic pattern; used in generating a captcha configuration</dd><dt><a class="struct" href="struct.UpdateEmail.html" title="struct db_core::UpdateEmail">Update<wbr>Email</a></dt><dd>data required to update them email of a user</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Login.html" title="enum db_core::Login">Login</a></dt><dd>types of credentials used as identifiers during login</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.CloneSPDatabase.html" title="trait db_core::CloneSPDatabase">CloneSP<wbr>Database</a></dt><dd>Trait to clone MCDatabase</dd><dt><a class="trait" href="trait.MCDatabase.html" title="trait db_core::MCDatabase">MCDatabase</a></dt><dd>mCaptcha’s database requirements. To implement support for $Database, kindly implement this
trait.</dd></dl><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.90.0/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.90.0/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.90.0/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink