actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2025-04-18 00:37:55 +02:00
Code Issues Releases Wiki Activity
actix-extras/src/actix_limitation/builder.rs.html

346 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../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="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">&#9776;</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"><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>
</pre><pre class="rust"><code><span class="kw">use </span>std::{borrow::Cow, sync::Arc, time::Duration};
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="kw">use </span>actix_session::SessionExt <span class="kw">as _</span>;
<span class="kw">use </span>actix_web::dev::ServiceRequest;
<span class="kw">use </span>redis::Client;
<span class="kw">use crate</span>::{errors::Error, GetArcBoxKeyFn, Limiter};
<span class="doccomment">/// Rate limiter builder.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Builder {
<span class="kw">pub</span>(<span class="kw">crate</span>) redis_url: String,
<span class="kw">pub</span>(<span class="kw">crate</span>) limit: usize,
<span class="kw">pub</span>(<span class="kw">crate</span>) period: Duration,
<span class="kw">pub</span>(<span class="kw">crate</span>) get_key_fn: <span class="prelude-ty">Option</span>&lt;GetArcBoxKeyFn&gt;,
<span class="kw">pub</span>(<span class="kw">crate</span>) cookie_name: Cow&lt;<span class="lifetime">&#39;static</span>, str&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) session_key: Cow&lt;<span class="lifetime">&#39;static</span>, str&gt;,
}
<span class="kw">impl </span>Builder {
<span class="doccomment">/// Set upper limit.
</span><span class="kw">pub fn </span>limit(<span class="kw-2">&amp;mut </span><span class="self">self</span>, limit: usize) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<span class="self">self</span>.limit = limit;
<span class="self">self
</span>}
<span class="doccomment">/// Set limit window/period.
</span><span class="kw">pub fn </span>period(<span class="kw-2">&amp;mut </span><span class="self">self</span>, period: Duration) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<span class="self">self</span>.period = period;
<span class="self">self
</span>}
<span class="doccomment">/// Sets rate limit key derivation function.
///
/// Should not be used in combination with `cookie_name` or `session_key` as they conflict.
</span><span class="kw">pub fn </span>key_by&lt;F&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, resolver: F) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self
</span><span class="kw">where
</span>F: Fn(<span class="kw-2">&amp;</span>ServiceRequest) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; + Send + Sync + <span class="lifetime">&#39;static</span>,
{
<span class="self">self</span>.get_key_fn = <span class="prelude-val">Some</span>(Arc::new(resolver));
<span class="self">self
</span>}
<span class="doccomment">/// Sets name of cookie to be sent.
///
/// This method should not be used in combination of `key_by` as they conflict.
</span><span class="attribute">#[deprecated = <span class="string">&quot;Prefer `key_by`.&quot;</span>]
</span><span class="kw">pub fn </span>cookie_name(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cookie_name: <span class="kw">impl </span>Into&lt;Cow&lt;<span class="lifetime">&#39;static</span>, str&gt;&gt;) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<span class="kw">if </span><span class="self">self</span>.get_key_fn.is_some() {
<span class="macro">panic!</span>(<span class="string">&quot;This method should not be used in combination of get_key as they overwrite each other&quot;</span>)
}
<span class="self">self</span>.cookie_name = cookie_name.into();
<span class="self">self
</span>}
<span class="doccomment">/// Sets session key to be used in backend.
///
/// This method should not be used in combination of `key_by` as they conflict.
</span><span class="attribute">#[deprecated = <span class="string">&quot;Prefer `key_by`.&quot;</span>]
#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="kw">pub fn </span>session_key(<span class="kw-2">&amp;mut </span><span class="self">self</span>, session_key: <span class="kw">impl </span>Into&lt;Cow&lt;<span class="lifetime">&#39;static</span>, str&gt;&gt;) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<span class="kw">if </span><span class="self">self</span>.get_key_fn.is_some() {
<span class="macro">panic!</span>(<span class="string">&quot;This method should not be used in combination of get_key as they overwrite each other&quot;</span>)
}
<span class="self">self</span>.session_key = session_key.into();
<span class="self">self
</span>}
<span class="doccomment">/// Finalizes and returns a `Limiter`.
///
/// Note that this method will connect to the Redis server to test its connection which is a
/// **synchronous** operation.
</span><span class="kw">pub fn </span>build(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Limiter, Error&gt; {
<span class="kw">let </span>get_key = <span class="kw">if let </span><span class="prelude-val">Some</span>(resolver) = <span class="self">self</span>.get_key_fn.clone() {
resolver
} <span class="kw">else </span>{
<span class="kw">let </span>cookie_name = <span class="self">self</span>.cookie_name.clone();
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="kw">let </span>session_key = <span class="self">self</span>.session_key.clone();
<span class="kw">let </span>closure: GetArcBoxKeyFn = Arc::new(Box::new(<span class="kw">move </span>|req: <span class="kw-2">&amp;</span>ServiceRequest| {
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="kw">let </span>res = req
.get_session()
.get(<span class="kw-2">&amp;</span>session_key)
.unwrap_or_else(|<span class="kw">_</span>| req.cookie(<span class="kw-2">&amp;</span>cookie_name).map(|c| c.to_string()));
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;session&quot;</span>))]
</span><span class="kw">let </span>res = req.cookie(<span class="kw-2">&amp;</span>cookie_name).map(|c| c.to_string());
res
}));
closure
};
<span class="prelude-val">Ok</span>(Limiter {
client: Client::open(<span class="self">self</span>.redis_url.as_str())<span class="question-mark">?</span>,
limit: <span class="self">self</span>.limit,
period: <span class="self">self</span>.period,
get_key_fn: get_key,
})
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_create_builder() {
<span class="kw">let </span>redis_url = <span class="string">&quot;redis://127.0.0.1&quot;</span>;
<span class="kw">let </span>period = Duration::from_secs(<span class="number">10</span>);
<span class="kw">let </span>builder = Builder {
redis_url: redis_url.to_owned(),
limit: <span class="number">100</span>,
period,
get_key_fn: <span class="prelude-val">Some</span>(Arc::new(|<span class="kw">_</span>| <span class="prelude-val">None</span>)),
cookie_name: Cow::Owned(<span class="string">&quot;session&quot;</span>.to_string()),
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span>session_key: Cow::Owned(<span class="string">&quot;rate-api&quot;</span>.to_string()),
};
<span class="macro">assert_eq!</span>(builder.redis_url, redis_url);
<span class="macro">assert_eq!</span>(builder.limit, <span class="number">100</span>);
<span class="macro">assert_eq!</span>(builder.period, period);
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span><span class="macro">assert_eq!</span>(builder.session_key, <span class="string">&quot;rate-api&quot;</span>);
<span class="macro">assert_eq!</span>(builder.cookie_name, <span class="string">&quot;session&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_create_limiter() {
<span class="kw">let </span>redis_url = <span class="string">&quot;redis://127.0.0.1&quot;</span>;
<span class="kw">let </span>period = Duration::from_secs(<span class="number">20</span>);
<span class="kw">let </span><span class="kw-2">mut </span>builder = Builder {
redis_url: redis_url.to_owned(),
limit: <span class="number">100</span>,
period: Duration::from_secs(<span class="number">10</span>),
get_key_fn: <span class="prelude-val">Some</span>(Arc::new(|<span class="kw">_</span>| <span class="prelude-val">None</span>)),
cookie_name: Cow::Borrowed(<span class="string">&quot;sid&quot;</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span>session_key: Cow::Borrowed(<span class="string">&quot;key&quot;</span>),
};
<span class="kw">let </span>limiter = builder.limit(<span class="number">200</span>).period(period).build().unwrap();
<span class="macro">assert_eq!</span>(limiter.limit, <span class="number">200</span>);
<span class="macro">assert_eq!</span>(limiter.period, period);
}
<span class="attribute">#[test]
#[should_panic = <span class="string">&quot;Redis URL did not parse&quot;</span>]
</span><span class="kw">fn </span>test_create_limiter_error() {
<span class="kw">let </span>redis_url = <span class="string">&quot;127.0.0.1&quot;</span>;
<span class="kw">let </span>period = Duration::from_secs(<span class="number">20</span>);
<span class="kw">let </span><span class="kw-2">mut </span>builder = Builder {
redis_url: redis_url.to_owned(),
limit: <span class="number">100</span>,
period: Duration::from_secs(<span class="number">10</span>),
get_key_fn: <span class="prelude-val">Some</span>(Arc::new(|<span class="kw">_</span>| <span class="prelude-val">None</span>)),
cookie_name: Cow::Borrowed(<span class="string">&quot;sid&quot;</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;session&quot;</span>)]
</span>session_key: Cow::Borrowed(<span class="string">&quot;key&quot;</span>),
};
builder.limit(<span class="number">200</span>).period(period).build().unwrap();
}
}
</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.66.0-nightly (432abd86f 2022-09-20)" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink