librepages/pages/db/index.html

1 line
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="API documentation for the Rust `db` mod in crate `pages`."><meta name="keywords" content="rust, rustlang, rust-lang, db"><title>pages::db - 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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.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="../../pages/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="../../pages/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module db</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../pages/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><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"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></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">pages</a>::<wbr><a class="mod" href="#">db</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/pages/db.rs.html#17-1031">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="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.Conn.html" title="pages::db::Conn struct">Conn</a></div><div class="item-right docblock-short">Use an existing database pool</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Database.html" title="pages::db::Database struct">Database</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EVENTS.html" title="pages::db::EVENTS struct">EVENTS</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EVENT_TYPE_CREATE.html" title="pages::db::EVENT_TYPE_CREATE struct">EVENT_TYPE_CREATE</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EVENT_TYPE_DELETE.html" title="pages::db::EVENT_TYPE_DELETE struct">EVENT_TYPE_DELETE</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EVENT_TYPE_UPDATE.html" title="pages::db::EVENT_TYPE_UPDATE struct">EVENT_TYPE_UPDATE</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Event.html" title="pages::db::Event struct">Event</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Fresh.html" title="pages::db::Fresh struct">Fresh</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InnerLibrepagesEvent.html" title="pages::db::InnerLibrepagesEvent struct">InnerLibrepagesEvent</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InnerSite.html" title="pages::db::InnerSite struct">InnerSite</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LibrePagesEvent.html" title="pages::db::LibrePagesEvent struct">LibrePagesEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NameHash.html" title="pages::db::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.Register.html" title="pages::db::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.Site.html" title="pages::db::Site struct">Site</a></div><div class="item-right docblock-short">Data required to add a new site</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UpdateEmail.html" title="pages::db::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.ConnectionOptions.html" title="pages::db::ConnectionOptions enum">ConnectionOptions</a></div><div class="item-right docblock-short">Connect to databse</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Login.html" title="pages::db::Login enum">Login</a></div><div class="item-right docblock-short">types of credentials used as identifiers during login</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_db.html" title="pages::db::get_db fn">get_db</a></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.map_register_err.html" title="pages::db::map_register_err fn">map_register_err</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short">map postgres errors to <a href="../errors/enum.ServiceError.html">ServiceError</a> types</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.map_row_not_found_err.html" title="pages::db::map_row_not_found_err fn">map_row_not_found_err</a></div><div class="item-right docblock-short">map custom row not found error to DB error</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.now_unix_time_stamp.html" title="pages::db::now_unix_time_stamp fn">now_unix_time_stamp</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pages" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>