mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 21:16:37 +02:00
Deploying to gh-pages from @ bb553b2308 🚀
This commit is contained in:
robjtede
254
src/actix_limitation/lib.rs.html
Normal file
254
src/actix_limitation/lib.rs.html
Normal file
@@ -0,0 +1,254 @@
|
||||
<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="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="../../actix_limitation/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="../../actix_limitation/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="../../actix_limitation/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
<span id="15">15</span>
|
||||
<span id="16">16</span>
|
||||
<span id="17">17</span>
|
||||
<span id="18">18</span>
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
<span id="28">28</span>
|
||||
<span id="29">29</span>
|
||||
<span id="30">30</span>
|
||||
<span id="31">31</span>
|
||||
<span id="32">32</span>
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
<span id="51">51</span>
|
||||
<span id="52">52</span>
|
||||
<span id="53">53</span>
|
||||
<span id="54">54</span>
|
||||
<span id="55">55</span>
|
||||
<span id="56">56</span>
|
||||
<span id="57">57</span>
|
||||
<span id="58">58</span>
|
||||
<span id="59">59</span>
|
||||
<span id="60">60</span>
|
||||
<span id="61">61</span>
|
||||
<span id="62">62</span>
|
||||
<span id="63">63</span>
|
||||
<span id="64">64</span>
|
||||
<span id="65">65</span>
|
||||
<span id="66">66</span>
|
||||
<span id="67">67</span>
|
||||
<span id="68">68</span>
|
||||
<span id="69">69</span>
|
||||
<span id="70">70</span>
|
||||
<span id="71">71</span>
|
||||
<span id="72">72</span>
|
||||
<span id="73">73</span>
|
||||
<span id="74">74</span>
|
||||
<span id="75">75</span>
|
||||
<span id="76">76</span>
|
||||
<span id="77">77</span>
|
||||
<span id="78">78</span>
|
||||
<span id="79">79</span>
|
||||
<span id="80">80</span>
|
||||
<span id="81">81</span>
|
||||
<span id="82">82</span>
|
||||
<span id="83">83</span>
|
||||
<span id="84">84</span>
|
||||
<span id="85">85</span>
|
||||
<span id="86">86</span>
|
||||
<span id="87">87</span>
|
||||
<span id="88">88</span>
|
||||
<span id="89">89</span>
|
||||
<span id="90">90</span>
|
||||
<span id="91">91</span>
|
||||
<span id="92">92</span>
|
||||
<span id="93">93</span>
|
||||
<span id="94">94</span>
|
||||
<span id="95">95</span>
|
||||
<span id="96">96</span>
|
||||
<span id="97">97</span>
|
||||
<span id="98">98</span>
|
||||
<span id="99">99</span>
|
||||
<span id="100">100</span>
|
||||
<span id="101">101</span>
|
||||
<span id="102">102</span>
|
||||
<span id="103">103</span>
|
||||
<span id="104">104</span>
|
||||
<span id="105">105</span>
|
||||
<span id="106">106</span>
|
||||
<span id="107">107</span>
|
||||
<span id="108">108</span>
|
||||
<span id="109">109</span>
|
||||
<span id="110">110</span>
|
||||
<span id="111">111</span>
|
||||
<span id="112">112</span>
|
||||
<span id="113">113</span>
|
||||
<span id="114">114</span>
|
||||
<span id="115">115</span>
|
||||
<span id="116">116</span>
|
||||
<span id="117">117</span>
|
||||
<span id="118">118</span>
|
||||
<span id="119">119</span>
|
||||
<span id="120">120</span>
|
||||
<span id="121">121</span>
|
||||
<span id="122">122</span>
|
||||
<span id="123">123</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">/*!
|
||||
Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
actix-limitation = "0.1.4"
|
||||
actix-web = "4"
|
||||
```
|
||||
|
||||
```no_run
|
||||
use std::time::Duration;
|
||||
use actix_web::{get, web, App, HttpServer, Responder};
|
||||
use actix_limitation::{Limiter, RateLimiter};
|
||||
|
||||
#[get("/{id}/{name}")]
|
||||
async fn index(info: web::Path<(u32, String)>) -> impl Responder {
|
||||
format!("Hello {}! id:{}", info.1, info.0)
|
||||
}
|
||||
|
||||
#[actix_web::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
let limiter = web::Data::new(
|
||||
Limiter::build("redis://127.0.0.1")
|
||||
.cookie_name("session-id".to_owned())
|
||||
.session_key("rate-api-id".to_owned())
|
||||
.limit(5000)
|
||||
.period(Duration::from_secs(3600)) // 60 minutes
|
||||
.finish()
|
||||
.expect("Can't build actix-limiter"),
|
||||
);
|
||||
|
||||
HttpServer::new(move || {
|
||||
App::new()
|
||||
.wrap(RateLimiter)
|
||||
.app_data(limiter.clone())
|
||||
.service(index)
|
||||
})
|
||||
.bind("127.0.0.1:8080")?
|
||||
.run()
|
||||
.await
|
||||
}
|
||||
```
|
||||
*/</span>
|
||||
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">log</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">redis::Client</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::time::Duration</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::core</span>::{<span class="ident">builder::Builder</span>, <span class="ident">errors::Error</span>, <span class="ident">status::Status</span>};
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::middleware::RateLimiter</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DEFAULT_REQUEST_LIMIT</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">5000</span>;
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DEFAULT_PERIOD_SECS</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">3600</span>;
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DEFAULT_COOKIE_NAME</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"sid"</span>;
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">DEFAULT_SESSION_KEY</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"rate-api-id"</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Limiter</span> {
|
||||
<span class="ident">client</span>: <span class="ident">Client</span>,
|
||||
<span class="ident">limit</span>: <span class="ident">usize</span>,
|
||||
<span class="ident">period</span>: <span class="ident">Duration</span>,
|
||||
<span class="ident">cookie_name</span>: <span class="ident">String</span>,
|
||||
<span class="ident">session_key</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Limiter</span> {
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="ident">redis_url</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">Builder</span> {
|
||||
<span class="ident">Builder</span> {
|
||||
<span class="ident">redis_url</span>,
|
||||
<span class="ident">limit</span>: <span class="ident">DEFAULT_REQUEST_LIMIT</span>,
|
||||
<span class="ident">period</span>: <span class="ident">Duration::from_secs</span>(<span class="ident">DEFAULT_PERIOD_SECS</span>),
|
||||
<span class="ident">cookie_name</span>: <span class="ident">DEFAULT_COOKIE_NAME</span>.<span class="ident">to_string</span>(),
|
||||
<span class="ident">session_key</span>: <span class="ident">DEFAULT_SESSION_KEY</span>.<span class="ident">to_string</span>(),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">count</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="ident">K</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Status</span>, <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> (<span class="ident">count</span>, <span class="ident">reset</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">track</span>(<span class="ident">key</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">status</span> <span class="op">=</span> <span class="ident">Status::build_status</span>(<span class="ident">count</span>, <span class="self">self</span>.<span class="ident">limit</span>, <span class="ident">reset</span>);
|
||||
|
||||
<span class="kw">if</span> <span class="ident">count</span> <span class="op">></span> <span class="self">self</span>.<span class="ident">limit</span> {
|
||||
<span class="prelude-val">Err</span>(<span class="ident">Error::LimitExceeded</span>(<span class="ident">status</span>))
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">status</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Tracks the given key in a period and returns the count and TTL for the key in seconds.</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">track</span><span class="op"><</span><span class="ident">K</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="ident">K</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">usize</span>, <span class="ident">usize</span>), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">key</span>.<span class="ident">into</span>();
|
||||
<span class="kw">let</span> <span class="ident">exipres</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">period</span>.<span class="ident">as_secs</span>();
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">connection</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">client</span>.<span class="ident">get_tokio_connection</span>().<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// The seed of this approach is outlined Atul R in a blog post about rate limiting</span>
|
||||
<span class="comment">// using NodeJS and Redis. For more details, see</span>
|
||||
<span class="comment">// https://blog.atulr.com/rate-limiter/</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">pipe</span> <span class="op">=</span> <span class="ident">redis::pipe</span>();
|
||||
<span class="ident">pipe</span>.<span class="ident">atomic</span>()
|
||||
.<span class="ident">cmd</span>(<span class="string">"SET"</span>)
|
||||
.<span class="ident">arg</span>(<span class="kw-2">&</span><span class="ident">key</span>)
|
||||
.<span class="ident">arg</span>(<span class="number">0</span>)
|
||||
.<span class="ident">arg</span>(<span class="string">"EX"</span>)
|
||||
.<span class="ident">arg</span>(<span class="ident">exipres</span>)
|
||||
.<span class="ident">arg</span>(<span class="string">"NX"</span>)
|
||||
.<span class="ident">ignore</span>()
|
||||
.<span class="ident">cmd</span>(<span class="string">"INCR"</span>)
|
||||
.<span class="ident">arg</span>(<span class="kw-2">&</span><span class="ident">key</span>)
|
||||
.<span class="ident">cmd</span>(<span class="string">"TTL"</span>)
|
||||
.<span class="ident">arg</span>(<span class="kw-2">&</span><span class="ident">key</span>);
|
||||
|
||||
<span class="kw">let</span> (<span class="ident">count</span>, <span class="ident">ttl</span>): (<span class="ident">usize</span>, <span class="ident">u64</span>) <span class="op">=</span> <span class="ident">pipe</span>.<span class="ident">query_async</span>(<span class="kw-2">&mut</span> <span class="ident">connection</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">reset</span> <span class="op">=</span> <span class="ident">Status::epoch_utc_plus</span>(<span class="ident">Duration::from_secs</span>(<span class="ident">ttl</span>))<span class="question-mark">?</span>;
|
||||
<span class="prelude-val">Ok</span>((<span class="ident">count</span>, <span class="ident">reset</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">core</span>;
|
||||
<span class="kw">mod</span> <span class="ident">middleware</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">test</span>;
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></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.61.0-nightly (58f11791a 2022-03-17)" ></div>
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user