mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2025-06-13 01:26:39 +00:00
2 lines
11 KiB
HTML
2 lines
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="API documentation for the Rust `prelude` mod in crate `db_sqlx_maria`."><meta name="keywords" content="rust, rustlang, rust-lang, prelude"><title>db_sqlx_maria::prelude - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.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"><!--[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_sqlx_maria/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_sqlx_maria/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module prelude</a></h2><div class="sidebar-elems"><section><ul class="block"><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><li><a href="#types">Type Definitions</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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">db_sqlx_maria</a>::<wbr><a class="mod" href="#">prelude</a><button id="copy-path" onclick="copy_path(this)" 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="srclink" href="../../src/db_sqlx_maria/lib.rs.html#60">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><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"><code>pub use <a class="mod" href="../index.html" title="mod db_sqlx_maria">super</a>::*;</code></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="ops/index.html" title="db_sqlx_maria::prelude::ops mod">ops</a></div><div class="item-right docblock-short">meta operations like migration and connecting to a database</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tests/index.html" title="db_sqlx_maria::prelude::tests mod">tests</a></div><div class="item-right docblock-short">Test utilities</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_sqlx_maria::prelude::AddNotification struct">AddNotification</a></div><div class="item-right docblock-short">Data required to add notification</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Captcha.html" title="db_sqlx_maria::prelude::Captcha struct">Captcha</a></div><div class="item-right docblock-short">Data representing a captcha</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CreateCaptcha.html" title="db_sqlx_maria::prelude::CreateCaptcha struct">CreateCaptcha</a></div><div class="item-right docblock-short">data required to create new captcha</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Level.html" title="db_sqlx_maria::prelude::Level struct">Level</a></div><div class="item-right docblock-short">Level struct that describes threshold-difficulty factor mapping</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NameHash.html" title="db_sqlx_maria::prelude::NameHash struct">NameHash</a></div><div class="item-right docblock-short">type encapsulating username and hashed password of a user</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Notification.html" title="db_sqlx_maria::prelude::Notification struct">Notification</a></div><div class="item-right docblock-short">Represents notification</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Register.html" title="db_sqlx_maria::prelude::Register struct">Register</a></div><div class="item-right docblock-short">Data required to register a new user</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Secret.html" title="db_sqlx_maria::prelude::Secret struct">Secret</a></div><div class="item-right docblock-short">datastructure representing a user’s secret</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StatsUnixTimestamp.html" title="db_sqlx_maria::prelude::StatsUnixTimestamp struct">StatsUnixTimestamp</a></div><div class="item-right docblock-short">Captcha statistics with time recorded in UNIX epoch formats</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrafficPattern.html" title="db_sqlx_maria::prelude::TrafficPattern struct">TrafficPattern</a></div><div class="item-right docblock-short">User’s traffic pattern; used in generating a captcha configuration</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UpdateEmail.html" title="db_sqlx_maria::prelude::UpdateEmail struct">UpdateEmail</a></div><div class="item-right docblock-short">data required to update them email of a user</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.DBError.html" title="db_sqlx_maria::prelude::DBError enum">DBError</a></div><div class="item-right docblock-short">Error data structure grouping various error subtypes</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Login.html" title="db_sqlx_maria::prelude::Login enum">Login</a></div><div class="item-right docblock-short">types of credentials used as identifiers during login</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_sqlx_maria::prelude::CloneSPDatabase trait">CloneSPDatabase</a></div><div class="item-right docblock-short">Trait to clone MCDatabase</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Connect.html" title="db_sqlx_maria::prelude::Connect trait">Connect</a></div><div class="item-right docblock-short">Create database connection</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.DBOps.html" title="db_sqlx_maria::prelude::DBOps trait">DBOps</a></div><div class="item-right docblock-short">Database operations trait(migrations, pool creation and fetching connection from pool)</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.GetConnection.html" title="db_sqlx_maria::prelude::GetConnection trait">GetConnection</a></div><div class="item-right docblock-short">Get database connection</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.MCDatabase.html" title="db_sqlx_maria::prelude::MCDatabase trait">MCDatabase</a></div><div class="item-right docblock-short">mCaptcha’s database requirements. To implement support for $Database, kindly implement this
|
||
trait.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Migrate.html" title="db_sqlx_maria::prelude::Migrate trait">Migrate</a></div><div class="item-right docblock-short">database migrations</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BoxDynError.html" title="db_sqlx_maria::prelude::BoxDynError type">BoxDynError</a></div><div class="item-right docblock-short">Convenience type alias for grouping driver-specific errors</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DBResult.html" title="db_sqlx_maria::prelude::DBResult type">DBResult</a></div><div class="item-right docblock-short">Generic result data structure</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="db_sqlx_maria" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.1 (8460ca823 2023-03-20)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html> |