<!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 to the Rust file `/home/asaka/.cargo/registry/src/github.com-1ecc6299db9ec823/r2d2-0.8.3/src/config.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>config.rs.html -- source</title><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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><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>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">scheduled_thread_pool</span>::<span class="ident">ScheduledThreadPool</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">marker</span>::<span class="ident">PhantomData</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
<span class="kw">use</span> {
<span class="ident">CustomizeConnection</span>, <span class="ident">Error</span>, <span class="ident">HandleError</span>, <span class="ident">LoggingErrorHandler</span>, <span class="ident">ManageConnection</span>,
<span class="ident">NopConnectionCustomizer</span>, <span class="ident">Pool</span>,
};
<span class="doccomment">/// A builder for a connection pool.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">M</span>: <span class="ident">ManageConnection</span>,
{
<span class="ident">max_size</span>: <span class="ident">u32</span>,
<span class="ident">min_idle</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>,
<span class="ident">test_on_check_out</span>: <span class="ident">bool</span>,
<span class="ident">max_lifetime</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
<span class="ident">idle_timeout</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
<span class="ident">connection_timeout</span>: <span class="ident">Duration</span>,
<span class="ident">error_handler</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">HandleError</span><span class="op"><</span><span class="ident">M</span>::<span class="ident">Error</span><span class="op">>></span>,
<span class="ident">connection_customizer</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CustomizeConnection</span><span class="op"><</span><span class="ident">M</span>::<span class="ident">Connection</span>, <span class="ident">M</span>::<span class="ident">Error</span><span class="op">>></span>,
<span class="ident">thread_pool</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">ScheduledThreadPool</span><span class="op">>></span>,
<span class="ident">reaper_rate</span>: <span class="ident">Duration</span>,
<span class="ident">_p</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">M</span>: <span class="ident">ManageConnection</span>,
{
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">fmt</span>.<span class="ident">debug_struct</span>(<span class="string">"Builder"</span>)
.<span class="ident">field</span>(<span class="string">"max_size"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">max_size</span>)
.<span class="ident">field</span>(<span class="string">"min_idle"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">min_idle</span>)
.<span class="ident">field</span>(<span class="string">"test_on_check_out"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">test_on_check_out</span>)
.<span class="ident">field</span>(<span class="string">"max_lifetime"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">max_lifetime</span>)
.<span class="ident">field</span>(<span class="string">"idle_timeout"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">idle_timeout</span>)
.<span class="ident">field</span>(<span class="string">"connection_timeout"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">connection_timeout</span>)
.<span class="ident">field</span>(<span class="string">"error_handler"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">error_handler</span>)
.<span class="ident">field</span>(<span class="string">"connection_customizer"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">connection_customizer</span>)
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">M</span>: <span class="ident">ManageConnection</span>,
{
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="ident">Builder</span> {
<span class="ident">max_size</span>: <span class="number">10</span>,
<span class="ident">min_idle</span>: <span class="prelude-val">None</span>,
<span class="ident">test_on_check_out</span>: <span class="bool-val">true</span>,
<span class="ident">idle_timeout</span>: <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">10</span> <span class="op">*</span> <span class="number">60</span>)),
<span class="ident">max_lifetime</span>: <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">30</span> <span class="op">*</span> <span class="number">60</span>)),
<span class="ident">connection_timeout</span>: <span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">30</span>),
<span class="ident">error_handler</span>: <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">LoggingErrorHandler</span>),
<span class="ident">connection_customizer</span>: <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">NopConnectionCustomizer</span>),
<span class="ident">thread_pool</span>: <span class="prelude-val">None</span>,
<span class="ident">reaper_rate</span>: <span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">30</span>),
<span class="ident">_p</span>: <span class="ident">PhantomData</span>,
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">M</span>: <span class="ident">ManageConnection</span>,
{
<span class="doccomment">/// Constructs a new `Builder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Parameters are initialized with their default values.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="ident">Builder</span>::<span class="ident">default</span>()
}
<span class="doccomment">/// Sets the maximum number of connections managed by the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to 10.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `max_size` is 0.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_size</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">max_size</span>: <span class="ident">u32</span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">max_size</span> <span class="op">></span> <span class="number">0</span>, <span class="string">"max_size must be positive"</span>);
<span class="self">self</span>.<span class="ident">max_size</span> <span class="op">=</span> <span class="ident">max_size</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the minimum idle connection count maintained by the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If set, the pool will try to maintain at least this many idle</span>
<span class="doccomment">/// connections at all times, while respecting the value of `max_size`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to `None` (equivalent to the value of `max_size`).</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_idle</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">min_idle</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">min_idle</span> <span class="op">=</span> <span class="ident">min_idle</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the thread pool used for asynchronous operations such as connection</span>
<span class="doccomment">/// creation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to a new pool with 3 threads.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">thread_pool</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">thread_pool</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">ScheduledThreadPool</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">thread_pool</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">thread_pool</span>);
<span class="self">self</span>
}
<span class="doccomment">/// If true, the health of a connection will be verified via a call to</span>
<span class="doccomment">/// `ConnectionManager::is_valid` before it is checked out of the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to true.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">test_on_check_out</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">test_on_check_out</span>: <span class="ident">bool</span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">test_on_check_out</span> <span class="op">=</span> <span class="ident">test_on_check_out</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the maximum lifetime of connections in the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If set, connections will be closed after existing for at most 30 seconds</span>
<span class="doccomment">/// beyond this duration.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If a connection reaches its maximum lifetime while checked out it will</span>
<span class="doccomment">/// be closed when it is returned to the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to 30 minutes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `max_lifetime` is the zero `Duration`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_lifetime</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">max_lifetime</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(
<span class="ident">max_lifetime</span> <span class="op">!=</span> <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">0</span>)),
<span class="string">"max_lifetime must be positive"</span>
);
<span class="self">self</span>.<span class="ident">max_lifetime</span> <span class="op">=</span> <span class="ident">max_lifetime</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the idle timeout used by the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If set, connections will be closed after sitting idle for at most 30</span>
<span class="doccomment">/// seconds beyond this duration.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to 10 minutes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `idle_timeout` is the zero `Duration`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">idle_timeout</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">idle_timeout</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(
<span class="ident">idle_timeout</span> <span class="op">!=</span> <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">0</span>)),
<span class="string">"idle_timeout must be positive"</span>
);
<span class="self">self</span>.<span class="ident">idle_timeout</span> <span class="op">=</span> <span class="ident">idle_timeout</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the connection timeout used by the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Calls to `Pool::get` will wait this long for a connection to become</span>
<span class="doccomment">/// available before returning an error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to 30 seconds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `connection_timeout` is the zero duration</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connection_timeout</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">connection_timeout</span>: <span class="ident">Duration</span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(
<span class="ident">connection_timeout</span> <span class="op">></span> <span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">0</span>),
<span class="string">"connection_timeout must be positive"</span>
);
<span class="self">self</span>.<span class="ident">connection_timeout</span> <span class="op">=</span> <span class="ident">connection_timeout</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the handler for errors reported in the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to the `LoggingErrorHandler`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">error_handler</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">error_handler</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">HandleError</span><span class="op"><</span><span class="ident">M</span>::<span class="ident">Error</span><span class="op">>></span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">error_handler</span> <span class="op">=</span> <span class="ident">error_handler</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the connection customizer used by the pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Defaults to the `NopConnectionCustomizer`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connection_customizer</span>(
<span class="kw-2">mut</span> <span class="self">self</span>,
<span class="ident">connection_customizer</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CustomizeConnection</span><span class="op"><</span><span class="ident">M</span>::<span class="ident">Connection</span>, <span class="ident">M</span>::<span class="ident">Error</span><span class="op">>></span>,
) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">connection_customizer</span> <span class="op">=</span> <span class="ident">connection_customizer</span>;
<span class="self">self</span>
}
<span class="comment">// used by tests</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">reaper_rate</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">reaper_rate</span>: <span class="ident">Duration</span>) <span class="op">-></span> <span class="ident">Builder</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">reaper_rate</span> <span class="op">=</span> <span class="ident">reaper_rate</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Consumes the builder, returning a new, initialized pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// It will block until the pool has established its configured minimum</span>
<span class="doccomment">/// number of connections, or it times out.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns an error if the pool is unable to open its minimum number of</span>
<span class="doccomment">/// connections.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `min_idle` is greater than `max_size`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>, <span class="ident">manager</span>: <span class="ident">M</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Pool</span><span class="op"><</span><span class="ident">M</span><span class="op">></span>, <span class="ident">Error</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">pool</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">build_unchecked</span>(<span class="ident">manager</span>);
<span class="ident">pool</span>.<span class="ident">wait_for_initialization</span>()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">pool</span>)
}
<span class="doccomment">/// Consumes the builder, returning a new pool.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unlike `build`, this method does not wait for any connections to be</span>
<span class="doccomment">/// established before returning.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics if `min_idle` is greater than `max_size`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build_unchecked</span>(<span class="self">self</span>, <span class="ident">manager</span>: <span class="ident">M</span>) <span class="op">-></span> <span class="ident">Pool</span><span class="op"><</span><span class="ident">M</span><span class="op">></span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">min_idle</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">min_idle</span> {
<span class="macro">assert</span><span class="macro">!</span>(
<span class="self">self</span>.<span class="ident">max_size</span> <span class="op">>=</span> <span class="ident">min_idle</span>,
<span class="string">"min_idle must be no larger than max_size"</span>
);
}
<span class="kw">let</span> <span class="ident">thread_pool</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">thread_pool</span> {
<span class="prelude-val">Some</span>(<span class="ident">thread_pool</span>) <span class="op">=></span> <span class="ident">thread_pool</span>,
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">ScheduledThreadPool</span>::<span class="ident">with_name</span>(<span class="string">"r2d2-worker-{}"</span>, <span class="number">3</span>)),
};
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">Config</span> {
<span class="ident">max_size</span>: <span class="self">self</span>.<span class="ident">max_size</span>,
<span class="ident">min_idle</span>: <span class="self">self</span>.<span class="ident">min_idle</span>,
<span class="ident">test_on_check_out</span>: <span class="self">self</span>.<span class="ident">test_on_check_out</span>,
<span class="ident">max_lifetime</span>: <span class="self">self</span>.<span class="ident">max_lifetime</span>,
<span class="ident">idle_timeout</span>: <span class="self">self</span>.<span class="ident">idle_timeout</span>,
<span class="ident">connection_timeout</span>: <span class="self">self</span>.<span class="ident">connection_timeout</span>,
<span class="ident">error_handler</span>: <span class="self">self</span>.<span class="ident">error_handler</span>,
<span class="ident">connection_customizer</span>: <span class="self">self</span>.<span class="ident">connection_customizer</span>,
<span class="ident">thread_pool</span>: <span class="ident">thread_pool</span>,
};
<span class="ident">Pool</span>::<span class="ident">new_inner</span>(<span class="ident">config</span>, <span class="ident">manager</span>, <span class="self">self</span>.<span class="ident">reaper_rate</span>)
}
}
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Config</span><span class="op"><</span><span class="ident">C</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">pub</span> <span class="ident">max_size</span>: <span class="ident">u32</span>,
<span class="kw">pub</span> <span class="ident">min_idle</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>,
<span class="kw">pub</span> <span class="ident">test_on_check_out</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">max_lifetime</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
<span class="kw">pub</span> <span class="ident">idle_timeout</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Duration</span><span class="op">></span>,
<span class="kw">pub</span> <span class="ident">connection_timeout</span>: <span class="ident">Duration</span>,
<span class="kw">pub</span> <span class="ident">error_handler</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">HandleError</span><span class="op"><</span><span class="ident">E</span><span class="op">>></span>,
<span class="kw">pub</span> <span class="ident">connection_customizer</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CustomizeConnection</span><span class="op"><</span><span class="ident">C</span>, <span class="ident">E</span><span class="op">>></span>,
<span class="kw">pub</span> <span class="ident">thread_pool</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">ScheduledThreadPool</span><span class="op">></span>,
}
<span class="comment">// manual to avoid bounds on C and E</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>, <span class="ident">E</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Config</span><span class="op"><</span><span class="ident">C</span>, <span class="ident">E</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">fmt</span>.<span class="ident">debug_struct</span>(<span class="string">"Config"</span>)
.<span class="ident">field</span>(<span class="string">"max_size"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">max_size</span>)
.<span class="ident">field</span>(<span class="string">"min_idle"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">min_idle</span>)
.<span class="ident">field</span>(<span class="string">"test_on_check_out"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">test_on_check_out</span>)
.<span class="ident">field</span>(<span class="string">"max_lifetime"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">max_lifetime</span>)
.<span class="ident">field</span>(<span class="string">"idle_timeout"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">idle_timeout</span>)
.<span class="ident">field</span>(<span class="string">"connection_timeout"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">connection_timeout</span>)
.<span class="ident">field</span>(<span class="string">"error_handler"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">error_handler</span>)
.<span class="ident">field</span>(<span class="string">"connection_customizer"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">connection_customizer</span>)
.<span class="ident">finish</span>()
}
}
</pre>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "r2d2";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>