<!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="Source of the Rust file `src/api/v1/routes.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>routes.rs - source</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 defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[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="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></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"><button type="button" id="help-button" title="help">?</button><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="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
</pre><pre class="rust"><code><span class="comment">/*
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/</span>
<span class="doccomment">//! V1 API Routes</span>
<span class="kw">use</span> <span class="ident">actix_auth_middleware::GetLoginRoute</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::deploy::routes::Deploy</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::meta::routes::Meta</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::serve::routes::Serve</span>;
<span class="doccomment">/// constant [Routes](Routes) instance</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">ROUTES</span>: <span class="ident">Routes</span> <span class="op">=</span> <span class="ident">Routes::new</span>();
<span class="doccomment">/// Authentication routes</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Auth</span> {
<span class="doccomment">/// logout route</span>
<span class="kw">pub</span> <span class="ident">logout</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// login route</span>
<span class="kw">pub</span> <span class="ident">login</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// registration route</span>
<span class="kw">pub</span> <span class="ident">register</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
}
<span class="kw">impl</span> <span class="ident">Auth</span> {
<span class="doccomment">/// create new instance of Authentication route</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="ident">Auth</span> {
<span class="kw">let</span> <span class="ident">login</span> <span class="op">=</span> <span class="string">"/api/v1/signin"</span>;
<span class="kw">let</span> <span class="ident">logout</span> <span class="op">=</span> <span class="string">"/api/v1/logout"</span>;
<span class="kw">let</span> <span class="ident">register</span> <span class="op">=</span> <span class="string">"/api/v1/signup"</span>;
<span class="ident">Auth</span> {
<span class="ident">logout</span>,
<span class="ident">login</span>,
<span class="ident">register</span>,
}
}
}
<span class="doccomment">/// Account management routes</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Account</span> {
<span class="doccomment">/// delete account route</span>
<span class="kw">pub</span> <span class="ident">delete</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// route to check if an email exists</span>
<span class="kw">pub</span> <span class="ident">email_exists</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// route to update a user's email</span>
<span class="kw">pub</span> <span class="ident">update_email</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// route to update password</span>
<span class="kw">pub</span> <span class="ident">update_password</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// route to check if a username is already registered</span>
<span class="kw">pub</span> <span class="ident">username_exists</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
<span class="doccomment">/// route to change username</span>
<span class="kw">pub</span> <span class="ident">update_username</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
}
<span class="kw">impl</span> <span class="ident">Account</span> {
<span class="doccomment">/// create a new instance of [Account][Account] routes</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="ident">Account</span> {
<span class="kw">let</span> <span class="ident">delete</span> <span class="op">=</span> <span class="string">"/api/v1/account/delete"</span>;
<span class="kw">let</span> <span class="ident">email_exists</span> <span class="op">=</span> <span class="string">"/api/v1/account/email/exists"</span>;
<span class="kw">let</span> <span class="ident">username_exists</span> <span class="op">=</span> <span class="string">"/api/v1/account/username/exists"</span>;
<span class="kw">let</span> <span class="ident">update_username</span> <span class="op">=</span> <span class="string">"/api/v1/account/username/update"</span>;
<span class="kw">let</span> <span class="ident">update_email</span> <span class="op">=</span> <span class="string">"/api/v1/account/email/update"</span>;
<span class="kw">let</span> <span class="ident">update_password</span> <span class="op">=</span> <span class="string">"/api/v1/account/password/update"</span>;
<span class="ident">Account</span> {
<span class="ident">delete</span>,
<span class="ident">email_exists</span>,
<span class="ident">update_email</span>,
<span class="ident">update_password</span>,
<span class="ident">username_exists</span>,
<span class="ident">update_username</span>,
}
}
}
<span class="doccomment">/// Top-level routes data structure for V1 AP1</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Routes</span> {
<span class="doccomment">/// Authentication routes</span>
<span class="kw">pub</span> <span class="ident">auth</span>: <span class="ident">Auth</span>,
<span class="doccomment">/// Account routes</span>
<span class="kw">pub</span> <span class="ident">account</span>: <span class="ident">Account</span>,
<span class="doccomment">/// Meta routes</span>
<span class="kw">pub</span> <span class="ident">meta</span>: <span class="ident">Meta</span>,
<span class="kw">pub</span> <span class="ident">deploy</span>: <span class="ident">Deploy</span>,
<span class="kw">pub</span> <span class="ident">serve</span>: <span class="ident">Serve</span>,
}
<span class="kw">impl</span> <span class="ident">Routes</span> {
<span class="doccomment">/// create new instance of Routes</span>
<span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="ident">Routes</span> {
<span class="ident">Routes</span> {
<span class="ident">auth</span>: <span class="ident">Auth::new</span>(),
<span class="ident">account</span>: <span class="ident">Account::new</span>(),
<span class="ident">meta</span>: <span class="ident">Meta::new</span>(),
<span class="ident">deploy</span>: <span class="ident">Deploy::new</span>(),
<span class="ident">serve</span>: <span class="ident">Serve::new</span>(),
}
}
}
<span class="kw">impl</span> <span class="ident">GetLoginRoute</span> <span class="kw">for</span> <span class="ident">Routes</span> {
<span class="kw">fn</span> <span class="ident">get_login_route</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">src</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span>) -> <span class="ident">String</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">redirect_to</span>) <span class="op">=</span> <span class="ident">src</span> {
<span class="macro">format!</span>(
<span class="string">"{}?redirect_to={}"</span>,
<span class="self">self</span>.<span class="ident">auth</span>.<span class="ident">login</span>,
<span class="ident">urlencoding::encode</span>(<span class="ident">redirect_to</span>)
)
} <span class="kw">else</span> {
<span class="self">self</span>.<span class="ident">auth</span>.<span class="ident">register</span>.<span class="ident">to_string</span>()
}
}
}
</code></pre></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.63.0 (4b91a6ea7 2022-08-08)" ></div>
</body></html>