<!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 `actix-limitation/src/builder.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>builder.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 src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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="../../actix_limitation/index.html"><div class="logo-container"><img src="https://actix.rs/img/logo.png" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../actix_limitation/index.html"><div class="logo-container">
<img src="https://actix.rs/img/logo.png" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_limitation/index.html">
<img src="https://actix.rs/img/logo.png" 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>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">time::Duration</span>};
<span class="kw">use</span> <span class="ident">redis::Client</span>;
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">errors::Error</span>, <span class="ident">Limiter</span>};
<span class="doccomment">/// Rate limit builder.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">redis_url</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">limit</span>: <span class="ident">usize</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">period</span>: <span class="ident">Duration</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">cookie_name</span>: <span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">session_key</span>: <span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> {
<span class="doccomment">/// Set upper limit.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">limit</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">limit</span>: <span class="ident">usize</span>) -> <span class="kw-2">&mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">limit</span> <span class="op">=</span> <span class="ident">limit</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set limit window/period.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">period</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">period</span>: <span class="ident">Duration</span>) -> <span class="kw-2">&mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">period</span> <span class="op">=</span> <span class="ident">period</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set name of cookie to be sent.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cookie_name</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">cookie_name</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>) -> <span class="kw-2">&mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">cookie_name</span> <span class="op">=</span> <span class="ident">cookie_name</span>.<span class="ident">into</span>();
<span class="self">self</span>
}
<span class="doccomment">/// Set session key to be used in backend.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">session_key</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">session_key</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>) -> <span class="kw-2">&mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">session_key</span> <span class="op">=</span> <span class="ident">session_key</span>.<span class="ident">into</span>();
<span class="self">self</span>
}
<span class="doccomment">/// Finalizes and returns a `Limiter`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this method will connect to the Redis server to test its connection which is a</span>
<span class="doccomment">/// **synchronous** operation.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Limiter</span>, <span class="ident">Error</span><span class="op">></span> {
<span class="prelude-val">Ok</span>(<span class="ident">Limiter</span> {
<span class="ident">client</span>: <span class="ident">Client::open</span>(<span class="self">self</span>.<span class="ident">redis_url</span>)<span class="question-mark">?</span>,
<span class="ident">limit</span>: <span class="self">self</span>.<span class="ident">limit</span>,
<span class="ident">period</span>: <span class="self">self</span>.<span class="ident">period</span>,
<span class="ident">cookie_name</span>: <span class="self">self</span>.<span class="ident">cookie_name</span>.<span class="ident">clone</span>(),
<span class="ident">session_key</span>: <span class="self">self</span>.<span class="ident">session_key</span>.<span class="ident">clone</span>(),
})
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_create_builder</span>() {
<span class="kw">let</span> <span class="ident">redis_url</span> <span class="op">=</span> <span class="string">"redis://127.0.0.1"</span>;
<span class="kw">let</span> <span class="ident">period</span> <span class="op">=</span> <span class="ident">Duration::from_secs</span>(<span class="number">10</span>);
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">Builder</span> {
<span class="ident">redis_url</span>,
<span class="ident">limit</span>: <span class="number">100</span>,
<span class="ident">period</span>,
<span class="ident">cookie_name</span>: <span class="ident">Cow::Owned</span>(<span class="string">"session"</span>.<span class="ident">to_string</span>()),
<span class="ident">session_key</span>: <span class="ident">Cow::Owned</span>(<span class="string">"rate-api"</span>.<span class="ident">to_string</span>()),
};
<span class="macro">assert_eq!</span>(<span class="ident">builder</span>.<span class="ident">redis_url</span>, <span class="ident">redis_url</span>);
<span class="macro">assert_eq!</span>(<span class="ident">builder</span>.<span class="ident">limit</span>, <span class="number">100</span>);
<span class="macro">assert_eq!</span>(<span class="ident">builder</span>.<span class="ident">period</span>, <span class="ident">period</span>);
<span class="macro">assert_eq!</span>(<span class="ident">builder</span>.<span class="ident">session_key</span>, <span class="string">"rate-api"</span>);
<span class="macro">assert_eq!</span>(<span class="ident">builder</span>.<span class="ident">cookie_name</span>, <span class="string">"session"</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_create_limiter</span>() {
<span class="kw">let</span> <span class="ident">redis_url</span> <span class="op">=</span> <span class="string">"redis://127.0.0.1"</span>;
<span class="kw">let</span> <span class="ident">period</span> <span class="op">=</span> <span class="ident">Duration::from_secs</span>(<span class="number">20</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">Builder</span> {
<span class="ident">redis_url</span>,
<span class="ident">limit</span>: <span class="number">100</span>,
<span class="ident">period</span>: <span class="ident">Duration::from_secs</span>(<span class="number">10</span>),
<span class="ident">session_key</span>: <span class="ident">Cow::Borrowed</span>(<span class="string">"key"</span>),
<span class="ident">cookie_name</span>: <span class="ident">Cow::Borrowed</span>(<span class="string">"sid"</span>),
};
<span class="kw">let</span> <span class="ident">limiter</span> <span class="op">=</span> <span class="ident">builder</span>
.<span class="ident">limit</span>(<span class="number">200</span>)
.<span class="ident">period</span>(<span class="ident">period</span>)
.<span class="ident">cookie_name</span>(<span class="string">"session"</span>.<span class="ident">to_string</span>())
.<span class="ident">session_key</span>(<span class="string">"rate-api"</span>.<span class="ident">to_string</span>())
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">limiter</span>.<span class="ident">limit</span>, <span class="number">200</span>);
<span class="macro">assert_eq!</span>(<span class="ident">limiter</span>.<span class="ident">period</span>, <span class="ident">period</span>);
<span class="macro">assert_eq!</span>(<span class="ident">limiter</span>.<span class="ident">session_key</span>, <span class="string">"rate-api"</span>);
<span class="macro">assert_eq!</span>(<span class="ident">limiter</span>.<span class="ident">cookie_name</span>, <span class="string">"session"</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">should_panic</span> <span class="op">=</span> <span class="string">"Redis URL did not parse"</span>]</span>
<span class="kw">fn</span> <span class="ident">test_create_limiter_error</span>() {
<span class="kw">let</span> <span class="ident">redis_url</span> <span class="op">=</span> <span class="string">"127.0.0.1"</span>;
<span class="kw">let</span> <span class="ident">period</span> <span class="op">=</span> <span class="ident">Duration::from_secs</span>(<span class="number">20</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">Builder</span> {
<span class="ident">redis_url</span>,
<span class="ident">limit</span>: <span class="number">100</span>,
<span class="ident">period</span>: <span class="ident">Duration::from_secs</span>(<span class="number">10</span>),
<span class="ident">session_key</span>: <span class="ident">Cow::Borrowed</span>(<span class="string">"key"</span>),
<span class="ident">cookie_name</span>: <span class="ident">Cow::Borrowed</span>(<span class="string">"sid"</span>),
};
<span class="ident">builder</span>.<span class="ident">limit</span>(<span class="number">200</span>).<span class="ident">period</span>(<span class="ident">period</span>).<span class="ident">build</span>().<span class="ident">unwrap</span>();
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_limitation" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (b31f9cc22 2022-06-15)" ></div>
</body></html>