mCaptcha/db_sqlx_postgres/dev/index.html
2022-05-30 10:35:30 +00:00

43 lines
No EOL
13 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="API documentation for the Rust `dev` mod in crate `db_sqlx_postgres`."><meta name="keywords" content="rust, rustlang, rust-lang, dev"><title>db_sqlx_postgres::dev - 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 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"><!--[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_sqlx_postgres/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_sqlx_postgres/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Module dev</a></h2><div class="sidebar-elems"><section><div class="block"><ul><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><li><a href="#attributes">Attribute Macros</a></li></ul></div></section><div id="sidebar-vars" data-name="dev" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../db_sqlx_postgres/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Module <a href="../index.html">db_sqlx_postgres</a>::<wbr><a class="mod" href="#">dev</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_sqlx_postgres/lib.rs.html#52-58">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></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 super::<a class="mod" href="../errors/index.html" title="mod db_sqlx_postgres::errors">errors</a>::*;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use super::<a class="struct" href="../struct.Database.html" title="struct db_sqlx_postgres::Database">Database</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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::CreateCaptcha struct">CreateCaptcha</a></div><div class="item-right docblock-short"><p>data requried 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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::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_sqlx_postgres::dev::Secret struct">Secret</a></div><div class="item-right docblock-short"><p>datastructure representing a users secret</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StatsUnixTimestamp.html" title="db_sqlx_postgres::dev::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_sqlx_postgres::dev::TrafficPattern struct">TrafficPattern</a></div><div class="item-right docblock-short"><p>Users 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_sqlx_postgres::dev::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.DBError.html" title="db_sqlx_postgres::dev::DBError enum">DBError</a></div><div class="item-right docblock-short"><p>Error data structure grouping various error subtypes</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="db_sqlx_postgres::dev::Error enum">Error</a></div><div class="item-right docblock-short"><p>Represents all the ways a method can fail within SQLx.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Login.html" title="db_sqlx_postgres::dev::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_sqlx_postgres::dev::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.Connect.html" title="db_sqlx_postgres::dev::Connect trait">Connect</a></div><div class="item-right docblock-short"><p>Create databse connection</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.DBOps.html" title="db_sqlx_postgres::dev::DBOps trait">DBOps</a></div><div class="item-right docblock-short"><p>Database operations trait(migrations, pool creation and fetching connection from pool)</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.GetConnection.html" title="db_sqlx_postgres::dev::GetConnection trait">GetConnection</a></div><div class="item-right docblock-short"><p>Get database connection</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.MCDatabase.html" title="db_sqlx_postgres::dev::MCDatabase trait">MCDatabase</a></div><div class="item-right docblock-short"><p>mCaptchas database requirements. To implement support for $Database, kindly implement this
trait.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Migrate.html" title="db_sqlx_postgres::dev::Migrate trait">Migrate</a></div><div class="item-right docblock-short"><p>database migrations</p>
</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_postgres::dev::BoxDynError type">BoxDynError</a></div><div class="item-right docblock-short"><p>Convenience type alias for grouping driver-specific errors</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DBResult.html" title="db_sqlx_postgres::dev::DBResult type">DBResult</a></div><div class="item-right docblock-short"><p>Generic result data structure</p>
</div></div></div><h2 id="attributes" class="small-section-header"><a href="#attributes">Attribute Macros</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="attr" href="attr.async_trait.html" title="db_sqlx_postgres::dev::async_trait attr">async_trait</a></div><div class="item-right docblock-short"></div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_sqlx_postgres" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
</body></html>