<!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 `database/src/library.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>library.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="../../database/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="../../database/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="../../database/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="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>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::DatabaseError</span>;
<span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
<span class="kw">use</span> <span class="ident">serde::Serialize</span>;
<span class="kw">use</span> <span class="ident">std::fmt</span>;
<span class="doccomment">/// Enum represents a media type and can be used on a library or on a media.</span>
<span class="doccomment">/// When returned in a http response, the fields are lowercase.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Serialize</span>, <span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Deserialize</span>, <span class="ident">Hash</span>, <span class="ident">sqlx::Type</span>)]</span>
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">rename_all</span> <span class="op">=</span> <span class="string">"lowercase"</span>)]</span>
<span class="attribute">#[<span class="ident">sqlx</span>(<span class="ident">rename_all</span> <span class="op">=</span> <span class="string">"lowercase"</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">MediaType</span> {
<span class="ident">Movie</span>,
<span class="ident">Tv</span>,
<span class="ident">Episode</span>,
}
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">MediaType</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
<span class="macro">write!</span>(
<span class="ident">f</span>,
<span class="string">"{}"</span>,
<span class="kw">match</span> <span class="self">self</span> {
<span class="ident"><span class="self">Self</span>::Movie</span> => <span class="string">"movie"</span>,
<span class="ident"><span class="self">Self</span>::Tv</span> => <span class="string">"tv"</span>,
<span class="ident"><span class="self">Self</span>::Episode</span> => <span class="string">"episode"</span>,
}
)
}
}
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">MediaType</span> {
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
<span class="ident"><span class="self">Self</span>::Movie</span>
}
}
<span class="doccomment">/// Library struct which we can use to deserialize database queries into.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>, <span class="ident">Deserialize</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Library</span> {
<span class="doccomment">/// unique id provided by postgres</span>
<span class="kw">pub</span> <span class="ident">id</span>: <span class="ident">i64</span>,
<span class="doccomment">/// unique name of the library</span>
<span class="kw">pub</span> <span class="ident">name</span>: <span class="ident">String</span>,
<span class="doccomment">/// a path on the filesystem that holds media. ie /home/user/media/movies</span>
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">skip_serializing_if</span> <span class="op">=</span> <span class="string">"Vec::is_empty"</span>)]</span>
<span class="kw">pub</span> <span class="ident">locations</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
<span class="doccomment">/// Enum used to identify the media type that this library contains. At the</span>
<span class="doccomment">/// moment only `movie` and `tv` are supported</span>
<span class="comment">// TODO: support mixed content, music</span>
<span class="kw">pub</span> <span class="ident">media_type</span>: <span class="ident">MediaType</span>,
}
<span class="kw">impl</span> <span class="ident">Library</span> {
<span class="doccomment">/// Method returns all libraries that exist in the database in the form of a Vec.</span>
<span class="doccomment">/// If no libraries are found the the Vec will just be empty.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will not return the locations indexed for this library, if you need those you</span>
<span class="doccomment">/// must query for them separately.</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_all</span>(<span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">Vec</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
<span class="macro">sqlx::query!</span>(<span class="string">r#"SELECT id, name, media_type as "media_type: MediaType" FROM library WHERE NOT hidden"#</span>)
.<span class="ident">fetch_all</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span>
.<span class="ident">unwrap_or_default</span>()
.<span class="ident">into_iter</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="self">Self</span> {
<span class="ident">id</span>: <span class="ident">x</span>.<span class="ident">id</span>,
<span class="ident">name</span>: <span class="ident">x</span>.<span class="ident">name</span>,
<span class="ident">media_type</span>: <span class="ident">x</span>.<span class="ident">media_type</span>,
<span class="ident">locations</span>: <span class="macro">vec!</span>[],
})
.<span class="ident">collect</span>()
}
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_locations</span>(
<span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>,
<span class="ident">id</span>: <span class="ident">i64</span>,
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="prelude-val">Ok</span>(<span class="macro">sqlx::query_scalar!</span>(
<span class="string">"SELECT location FROM indexed_paths
WHERE library_id = ?"</span>,
<span class="ident">id</span>
)
.<span class="ident">fetch_all</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>)
}
<span class="doccomment">/// Method filters the database for a library with the id supplied and returns it.</span>
<span class="doccomment">/// This method will also fetch the indexed locations for this library.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Arguments</span>
<span class="doccomment">/// * `conn` - mutable reference to a sqlx transaction.</span>
<span class="doccomment">/// * `lib_id` - a integer that is the id of the library we are trying to query</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_one</span>(
<span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>,
<span class="ident">lib_id</span>: <span class="ident">i64</span>,
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">library</span> <span class="op">=</span> <span class="macro">sqlx::query!</span>(
<span class="string">r#"SELECT id, name, media_type as "media_type: MediaType" FROM library
WHERE id = ?"#</span>,
<span class="ident">lib_id</span>
)
.<span class="ident">fetch_one</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">locations</span> <span class="op">=</span> <span class="macro">sqlx::query_scalar!</span>(
<span class="string">r#"SELECT location FROM indexed_paths
WHERE library_id = ?"#</span>,
<span class="ident">lib_id</span>
)
.<span class="ident">fetch_all</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">Self</span> {
<span class="ident">id</span>: <span class="ident">library</span>.<span class="ident">id</span>,
<span class="ident">name</span>: <span class="ident">library</span>.<span class="ident">name</span>,
<span class="ident">media_type</span>: <span class="ident">library</span>.<span class="ident">media_type</span>,
<span class="ident">locations</span>,
})
}
<span class="doccomment">/// Method filters the database for a library with the id supplied and deletes it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Arguments</span>
<span class="doccomment">/// * `conn` - mutable reference to a sqlx transaction.</span>
<span class="doccomment">/// * `lib_id` - a integer that is the id of the library we are trying to query</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete</span>(
<span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>,
<span class="ident">id_to_del</span>: <span class="ident">i64</span>,
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="prelude-val">Ok</span>(<span class="macro">sqlx::query!</span>(<span class="string">"DELETE FROM library WHERE id = ?"</span>, <span class="ident">id_to_del</span>)
.<span class="ident">execute</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>
.<span class="ident">rows_affected</span>() <span class="kw">as</span> <span class="ident">usize</span>)
}
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">mark_hidden</span>(
<span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>,
<span class="ident">id</span>: <span class="ident">i64</span>,
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="prelude-val">Ok</span>(
<span class="macro">sqlx::query!</span>(<span class="string">"UPDATE library SET hidden = 1 WHERE id = ?"</span>, <span class="ident">id</span>)
.<span class="ident">execute</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>
.<span class="ident">rows_affected</span>() <span class="kw">as</span> <span class="ident">usize</span>,
)
}
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_size</span>(
<span class="ident">tx</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>,
<span class="ident">id</span>: <span class="ident">i64</span>,
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="prelude-val">Ok</span>(<span class="macro">sqlx::query!</span>(
<span class="string">"SELECT COUNT(id) as size FROM _tblmedia WHERE library_id = ?"</span>,
<span class="ident">id</span>
)
.<span class="ident">fetch_one</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">tx</span>)
.<span class="kw">await</span><span class="question-mark">?</span>
.<span class="ident">size</span> <span class="kw">as</span> <span class="ident">usize</span>)
}
}
<span class="doccomment">/// InsertableLibrary struct, same as [`Library`](Library) but without the id field.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">InsertableLibrary</span> {
<span class="kw">pub</span> <span class="ident">name</span>: <span class="ident">String</span>,
<span class="kw">pub</span> <span class="ident">locations</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
<span class="kw">pub</span> <span class="ident">media_type</span>: <span class="ident">MediaType</span>,
}
<span class="kw">impl</span> <span class="ident">InsertableLibrary</span> {
<span class="doccomment">/// Method inserts a InsertableLibrary object into the database (makes a new library).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Arguments</span>
<span class="doccomment">/// * `conn` - mutable reference to a sqlx transaction.</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">insert</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">conn</span>: <span class="kw-2">&mut</span> <span class="ident"><span class="kw">crate</span>::Transaction</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">i64</span>, <span class="ident">DatabaseError</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">lib_id</span> <span class="op">=</span> <span class="macro">sqlx::query!</span>(
<span class="string">r#"INSERT INTO library (name, media_type) VALUES ($1, $2)"#</span>,
<span class="self">self</span>.<span class="ident">name</span>,
<span class="self">self</span>.<span class="ident">media_type</span>
)
.<span class="ident">execute</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>
.<span class="ident">last_insert_rowid</span>();
<span class="kw">for</span> <span class="ident">location</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">locations</span> {
<span class="macro">sqlx::query!</span>(
<span class="string">r#"INSERT into indexed_paths(location, library_id)
VALUES ($1, $2)"#</span>,
<span class="ident">location</span>,
<span class="ident">lib_id</span>
)
.<span class="ident">execute</span>(<span class="kw-2">&mut</span> <span class="kw-2">*</span><span class="ident">conn</span>)
.<span class="kw">await</span><span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(<span class="ident">lib_id</span>)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="database" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>