3 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="useful imports for users working with a supported database"><title>db_sqlx_maria::dev::prelude - 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-f3501f0f5ae15dfb.css" id="mainThemeStyle"><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.71.0 (8ede3aae2 2023-07-12)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../../static.files/dark-1097f8e92a01e3cf.css"><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">&#9776;</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-7b819b6101059cd0.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 href="../index.html">dev</a>::<wbr><a class="mod" href="#">prelude</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"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>useful imports for users working with a supported database</p>
</div></details><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_sqlx_maria::dev::prelude::dev">dev</a></div><div class="desc docblock-short">useful imports for supporting a new database</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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::Secret">Secret</a></div><div class="desc docblock-short">datastructure representing a users secret</div></li><li><div class="item-name"><a class="struct" href="struct.StatsUnixTimestamp.html" title="struct db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::TrafficPattern">TrafficPattern</a></div><div class="desc docblock-short">Users 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_sqlx_maria::dev::prelude::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.DBError.html" title="enum db_sqlx_maria::dev::prelude::DBError">DBError</a></div><div class="desc docblock-short">Error data structure grouping various error subtypes</div></li><li><div class="item-name"><a class="enum" href="enum.Login.html" title="enum db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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.Connect.html" title="trait db_sqlx_maria::dev::prelude::Connect">Connect</a></div><div class="desc docblock-short">Create database connection</div></li><li><div class="item-name"><a class="trait" href="trait.DBOps.html" title="trait db_sqlx_maria::dev::prelude::DBOps">DBOps</a></div><div class="desc docblock-short">Database operations trait(migrations, pool creation and fetching connection from pool)</div></li><li><div class="item-name"><a class="trait" href="trait.GetConnection.html" title="trait db_sqlx_maria::dev::prelude::GetConnection">GetConnection</a></div><div class="desc docblock-short">Get database connection</div></li><li><div class="item-name"><a class="trait" href="trait.MCDatabase.html" title="trait db_sqlx_maria::dev::prelude::MCDatabase">MCDatabase</a></div><div class="desc docblock-short">mCaptchas database requirements. To implement support for $Database, kindly implement this
trait.</div></li><li><div class="item-name"><a class="trait" href="trait.Migrate.html" title="trait db_sqlx_maria::dev::prelude::Migrate">Migrate</a></div><div class="desc docblock-short">database migrations</div></li></ul><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxDynError.html" title="type db_sqlx_maria::dev::prelude::BoxDynError">BoxDynError</a></div><div class="desc docblock-short">Convenience type alias for grouping driver-specific errors</div></li><li><div class="item-name"><a class="type" href="type.DBResult.html" title="type db_sqlx_maria::dev::prelude::DBResult">DBResult</a></div><div class="desc docblock-short">Generic result data structure</div></li></ul></section></div></main></body></html>