3 lines
8.4 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><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_sqlx_maria" 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="../sidebar-items.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"><!--[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_sqlx_maria/index.html">db_<wbr>sqlx_<wbr>maria</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module prelude</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In db_<wbr>sqlx_<wbr>maria::<wbr>dev</a></h2></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"><div class="rustdoc-breadcrumbs"><a href="../../index.html">db_sqlx_maria</a>::<wbr><a href="../index.html">dev</a></div><h1>Module <span>prelude</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></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="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_sqlx_maria::dev::prelude::dev">dev</a></dt><dd>useful imports for supporting a new database</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_sqlx_maria::dev::prelude::AddNotification">AddNotification</a></dt><dd>Data required to add notification</dd><dt><a class="struct" href="struct.Captcha.html" title="struct db_sqlx_maria::dev::prelude::Captcha">Captcha</a></dt><dd>Data representing a captcha</dd><dt><a class="struct" href="struct.CreateCaptcha.html" title="struct db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::EasyCaptcha">Easy<wbr>Captcha</a></dt><dd>Represents Easy captcha configuration</dd><dt><a class="struct" href="struct.Level.html" title="struct db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::Notification">Notification</a></dt><dd>Represents notification</dd><dt><a class="struct" href="struct.PerformanceAnalytics.html" title="struct db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::Register">Register</a></dt><dd>Data required to register a new user</dd><dt><a class="struct" href="struct.Secret.html" title="struct db_sqlx_maria::dev::prelude::Secret">Secret</a></dt><dd>datastructure representing a users secret</dd><dt><a class="struct" href="struct.StatsUnixTimestamp.html" title="struct db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::TrafficPattern">Traffic<wbr>Pattern</a></dt><dd>Users traffic pattern; used in generating a captcha configuration</dd><dt><a class="struct" href="struct.UpdateEmail.html" title="struct db_sqlx_maria::dev::prelude::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.DBError.html" title="enum db_sqlx_maria::dev::prelude::DBError">DBError</a></dt><dd>Error data structure grouping various error subtypes</dd><dt><a class="enum" href="enum.Login.html" title="enum db_sqlx_maria::dev::prelude::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_sqlx_maria::dev::prelude::CloneSPDatabase">CloneSP<wbr>Database</a></dt><dd>Trait to clone MCDatabase</dd><dt><a class="trait" href="trait.Connect.html" title="trait db_sqlx_maria::dev::prelude::Connect">Connect</a></dt><dd>Create database connection</dd><dt><a class="trait" href="trait.DBOps.html" title="trait db_sqlx_maria::dev::prelude::DBOps">DBOps</a></dt><dd>Database operations trait(migrations, pool creation and fetching connection from pool)</dd><dt><a class="trait" href="trait.GetConnection.html" title="trait db_sqlx_maria::dev::prelude::GetConnection">GetConnection</a></dt><dd>Get database connection</dd><dt><a class="trait" href="trait.MCDatabase.html" title="trait db_sqlx_maria::dev::prelude::MCDatabase">MCDatabase</a></dt><dd>mCaptchas database requirements. To implement support for $Database, kindly implement this
trait.</dd><dt><a class="trait" href="trait.Migrate.html" title="trait db_sqlx_maria::dev::prelude::Migrate">Migrate</a></dt><dd>database migrations</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.BoxDynError.html" title="type db_sqlx_maria::dev::prelude::BoxDynError">BoxDyn<wbr>Error</a></dt><dd>Convenience type alias for grouping driver-specific errors</dd><dt><a class="type" href="type.DBResult.html" title="type db_sqlx_maria::dev::prelude::DBResult">DBResult</a></dt><dd>Generic result data structure</dd></dl></section></div></main></body></html>